Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update docs #241

Merged
merged 6 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/crm/companies/api/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Create a company'
openapi: "POST /crm/company"
---
4 changes: 4 additions & 0 deletions docs/crm/companies/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Retrieve a company'
openapi: "GET /crm/company/{id}"
---
4 changes: 4 additions & 0 deletions docs/crm/companies/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'List companies'
openapi: "GET /crm/company"
---
5 changes: 5 additions & 0 deletions docs/crm/companies/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Update a company'
openapi: "PATCH /crm/company"
---

3 changes: 3 additions & 0 deletions docs/crm/companies/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Overview
---
4 changes: 2 additions & 2 deletions docs/crm/contacts/api/list.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'List all contacts'
description: 'Retrieve all contacts from all connected CRMs using one endpoint'
title: 'List contacts'
description: 'Retrieve contacts from all connected CRMs using one endpoint'
openapi: "GET /crm/contact"
---

Expand Down
5 changes: 5 additions & 0 deletions docs/crm/deals/api/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Create a Deal'
description: 'Create a Deal in any CRM Platform using this endpoint'
openapi: "POST /crm/deal"
---
5 changes: 5 additions & 0 deletions docs/crm/deals/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Retrieve a Deal'
description: 'Retrieve a Deal in any CRM Platform using this endpoint'
openapi: "GET /crm/deal/{id}"
---
5 changes: 5 additions & 0 deletions docs/crm/deals/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'List Deals'
description: 'List Deals in any CRM Platform using this endpoint'
openapi: "GET /crm/deal"
---
5 changes: 5 additions & 0 deletions docs/crm/deals/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Update a Deal'
description: 'Update a Deal in any CRM Platform using this endpoint'
openapi: "PATCH /crm/deal"
---
2 changes: 1 addition & 1 deletion docs/crm/deals/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'The Deal Object - TODO'
title: 'The Deal Object'
description: 'Introduction to our CRM `deal` Unified Model'

---
Expand Down
5 changes: 5 additions & 0 deletions docs/crm/engagements/api/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Create an Engagement'
description: 'Create an Engagement in any CRM Platform using this endpoint'
openapi: "POST /crm/engagement"
---
5 changes: 5 additions & 0 deletions docs/crm/engagements/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Retrieve an Engagement'
description: 'Retrieve an Engagement in any CRM Platform using this endpoint'
openapi: "GET /crm/engagement/{id}"
---
5 changes: 5 additions & 0 deletions docs/crm/engagements/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'List Engagements'
description: 'List Engagements in any CRM Platform using this endpoint'
openapi: "GET /crm/engagement"
---
5 changes: 5 additions & 0 deletions docs/crm/engagements/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Update an Engagement'
description: 'Update an Engagement in any CRM Platform using this endpoint'
openapi: "PATCH /crm/engagement"
---
5 changes: 5 additions & 0 deletions docs/crm/notes/api/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Create a Note'
description: 'Create a Note in any CRM Platform using this endpoint'
openapi: "POST /crm/note"
---
5 changes: 5 additions & 0 deletions docs/crm/notes/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Retrieve a Note'
description: 'Retrieve a Note in any CRM Platform using this endpoint'
openapi: "GET /crm/note/{id}"
---
5 changes: 5 additions & 0 deletions docs/crm/notes/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'List Notes'
description: 'List Notes in any CRM Platform using this endpoint'
openapi: "GET /crm/note"
---
5 changes: 5 additions & 0 deletions docs/crm/notes/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Update a Note'
description: 'Update a Note in any CRM Platform using this endpoint'
openapi: "PATCH /crm/note"
---
Empty file added docs/crm/tasks/api/create.mdx
Empty file.
5 changes: 5 additions & 0 deletions docs/crm/tasks/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Retrieve a Task'
description: 'List Task in any CRM Platform using this endpoint'
openapi: "GET /crm/task/{id}"
---
5 changes: 5 additions & 0 deletions docs/crm/tasks/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'List Tasks'
description: 'List Tasks in any CRM Platform using this endpoint'
openapi: "GET /crm/task"
---
3 changes: 3 additions & 0 deletions docs/crm/tasks/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: "PATCH /crm/task"
---
5 changes: 5 additions & 0 deletions docs/crm/users/api/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Retrieve a User'
description: 'Retrieve a User in any CRM Platform using this endpoint'
openapi: "GET /crm/user/{id}"
---
5 changes: 5 additions & 0 deletions docs/crm/users/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'List Users'
description: 'List Users in any CRM Platform using this endpoint'
openapi: "GET /crm/user"
---
Loading
Loading