From 46166c336e1ff38520fcf239f7747e21dcbe61e5 Mon Sep 17 00:00:00 2001 From: Rachid F Date: Wed, 24 Jan 2024 17:08:40 +0100 Subject: [PATCH 1/6] :memo: Update docs --- docs/crm/companies/api/create.mdx | 4 + docs/crm/companies/api/get.mdx | 4 + docs/crm/companies/api/list.mdx | 4 + docs/crm/companies/api/update.mdx | 5 + docs/crm/companies/overview.mdx | 3 + docs/crm/contacts/api/list.mdx | 4 +- docs/crm/deals/api/create.mdx | 5 + docs/crm/deals/api/get.mdx | 5 + docs/crm/deals/api/list.mdx | 5 + docs/crm/deals/api/update.mdx | 5 + docs/crm/deals/overview.mdx | 2 +- docs/crm/engagements/api/create.mdx | 5 + docs/crm/engagements/api/get.mdx | 5 + docs/crm/engagements/api/list.mdx | 5 + docs/crm/engagements/api/update.mdx | 5 + docs/crm/notes/api/create.mdx | 5 + docs/crm/notes/api/get.mdx | 5 + docs/crm/notes/api/list.mdx | 5 + docs/crm/notes/api/update.mdx | 5 + docs/crm/tasks/api/create.mdx | 0 docs/crm/tasks/api/get.mdx | 5 + docs/crm/tasks/api/list.mdx | 5 + docs/crm/tasks/api/update.mdx | 3 + docs/crm/users/api/get.mdx | 5 + docs/crm/users/api/list.mdx | 5 + docs/mint.json | 465 +++++++++--------- docs/open-source/contributors.mdx | 6 + docs/ticketing/accounts/api/create.mdx | 5 + docs/ticketing/accounts/api/get.mdx | 5 + docs/ticketing/accounts/api/list.mdx | 5 + docs/ticketing/accounts/api/update.mdx | 5 + .../comments/api/{post.mdx => create.mdx} | 0 docs/ticketing/comments/api/list.mdx | 2 +- docs/ticketing/comments/api/update.mdx | 5 + docs/ticketing/contacts/api/create.mdx | 5 + docs/ticketing/contacts/api/get.mdx | 5 + docs/ticketing/contacts/api/list.mdx | 5 + docs/ticketing/contacts/api/update.mdx | 5 + docs/ticketing/tags/api/get.mdx | 5 + docs/ticketing/tags/api/list.mdx | 5 + docs/ticketing/teams/api/create.mdx | 0 docs/ticketing/teams/api/get.mdx | 5 + docs/ticketing/teams/api/list.mdx | 5 + docs/ticketing/teams/api/update.mdx | 0 docs/ticketing/tickets/api/create.mdx | 5 + docs/ticketing/tickets/api/get.mdx | 8 +- docs/ticketing/tickets/api/list.mdx | 5 + docs/ticketing/tickets/api/post.mdx | 5 - docs/ticketing/tickets/api/update.mdx | 5 + docs/ticketing/users/api/get.mdx | 5 + docs/ticketing/users/api/list.mdx | 5 + 51 files changed, 440 insertions(+), 245 deletions(-) create mode 100644 docs/crm/companies/api/create.mdx create mode 100644 docs/crm/companies/api/get.mdx create mode 100644 docs/crm/companies/api/list.mdx create mode 100644 docs/crm/companies/api/update.mdx create mode 100644 docs/crm/companies/overview.mdx create mode 100644 docs/crm/deals/api/create.mdx create mode 100644 docs/crm/deals/api/get.mdx create mode 100644 docs/crm/deals/api/list.mdx create mode 100644 docs/crm/deals/api/update.mdx create mode 100644 docs/crm/engagements/api/create.mdx create mode 100644 docs/crm/engagements/api/get.mdx create mode 100644 docs/crm/engagements/api/list.mdx create mode 100644 docs/crm/engagements/api/update.mdx create mode 100644 docs/crm/notes/api/create.mdx create mode 100644 docs/crm/notes/api/get.mdx create mode 100644 docs/crm/notes/api/list.mdx create mode 100644 docs/crm/notes/api/update.mdx create mode 100644 docs/crm/tasks/api/create.mdx create mode 100644 docs/crm/tasks/api/get.mdx create mode 100644 docs/crm/tasks/api/list.mdx create mode 100644 docs/crm/tasks/api/update.mdx create mode 100644 docs/crm/users/api/get.mdx create mode 100644 docs/crm/users/api/list.mdx create mode 100644 docs/ticketing/accounts/api/create.mdx create mode 100644 docs/ticketing/accounts/api/get.mdx create mode 100644 docs/ticketing/accounts/api/list.mdx create mode 100644 docs/ticketing/accounts/api/update.mdx rename docs/ticketing/comments/api/{post.mdx => create.mdx} (100%) create mode 100644 docs/ticketing/comments/api/update.mdx create mode 100644 docs/ticketing/contacts/api/create.mdx create mode 100644 docs/ticketing/contacts/api/get.mdx create mode 100644 docs/ticketing/contacts/api/list.mdx create mode 100644 docs/ticketing/contacts/api/update.mdx create mode 100644 docs/ticketing/tags/api/get.mdx create mode 100644 docs/ticketing/tags/api/list.mdx create mode 100644 docs/ticketing/teams/api/create.mdx create mode 100644 docs/ticketing/teams/api/get.mdx create mode 100644 docs/ticketing/teams/api/list.mdx create mode 100644 docs/ticketing/teams/api/update.mdx create mode 100644 docs/ticketing/tickets/api/create.mdx create mode 100644 docs/ticketing/tickets/api/list.mdx delete mode 100644 docs/ticketing/tickets/api/post.mdx create mode 100644 docs/ticketing/tickets/api/update.mdx create mode 100644 docs/ticketing/users/api/get.mdx create mode 100644 docs/ticketing/users/api/list.mdx diff --git a/docs/crm/companies/api/create.mdx b/docs/crm/companies/api/create.mdx new file mode 100644 index 000000000..fbad023d6 --- /dev/null +++ b/docs/crm/companies/api/create.mdx @@ -0,0 +1,4 @@ +--- +title: 'Create a company' +openapi: "POST /crm/company" +--- \ No newline at end of file diff --git a/docs/crm/companies/api/get.mdx b/docs/crm/companies/api/get.mdx new file mode 100644 index 000000000..a4c427729 --- /dev/null +++ b/docs/crm/companies/api/get.mdx @@ -0,0 +1,4 @@ +--- +title: 'Retrieve a company' +openapi: "GET /crm/company/{id}" +--- \ No newline at end of file diff --git a/docs/crm/companies/api/list.mdx b/docs/crm/companies/api/list.mdx new file mode 100644 index 000000000..9ac83d144 --- /dev/null +++ b/docs/crm/companies/api/list.mdx @@ -0,0 +1,4 @@ +--- +title: 'List companies' +openapi: "GET /crm/company" +--- \ No newline at end of file diff --git a/docs/crm/companies/api/update.mdx b/docs/crm/companies/api/update.mdx new file mode 100644 index 000000000..c5ea2119e --- /dev/null +++ b/docs/crm/companies/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a company' +openapi: "PATCH /crm/company" +--- + diff --git a/docs/crm/companies/overview.mdx b/docs/crm/companies/overview.mdx new file mode 100644 index 000000000..7137deb37 --- /dev/null +++ b/docs/crm/companies/overview.mdx @@ -0,0 +1,3 @@ +--- +title: Overview +--- diff --git a/docs/crm/contacts/api/list.mdx b/docs/crm/contacts/api/list.mdx index e7ee16c64..046c65ef7 100644 --- a/docs/crm/contacts/api/list.mdx +++ b/docs/crm/contacts/api/list.mdx @@ -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" --- diff --git a/docs/crm/deals/api/create.mdx b/docs/crm/deals/api/create.mdx new file mode 100644 index 000000000..b88684d75 --- /dev/null +++ b/docs/crm/deals/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create a Deal' +description: 'Create a Deal in any CRM Platform using this endpoint' +openapi: "POST /crm/deal" +--- \ No newline at end of file diff --git a/docs/crm/deals/api/get.mdx b/docs/crm/deals/api/get.mdx new file mode 100644 index 000000000..4657b67e6 --- /dev/null +++ b/docs/crm/deals/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a Deal' +description: 'Retrieve a Deal in any CRM Platform using this endpoint' +openapi: "GET /crm/deal/{id}" +--- \ No newline at end of file diff --git a/docs/crm/deals/api/list.mdx b/docs/crm/deals/api/list.mdx new file mode 100644 index 000000000..6486be885 --- /dev/null +++ b/docs/crm/deals/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Deals' +description: 'List Deals in any CRM Platform using this endpoint' +openapi: "GET /crm/deal" +--- \ No newline at end of file diff --git a/docs/crm/deals/api/update.mdx b/docs/crm/deals/api/update.mdx new file mode 100644 index 000000000..69d8155e9 --- /dev/null +++ b/docs/crm/deals/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a Deal' +description: 'Update a Deal in any CRM Platform using this endpoint' +openapi: "PATCH /crm/deal" +--- \ No newline at end of file diff --git a/docs/crm/deals/overview.mdx b/docs/crm/deals/overview.mdx index 15133bbfa..65dc29e2e 100644 --- a/docs/crm/deals/overview.mdx +++ b/docs/crm/deals/overview.mdx @@ -1,5 +1,5 @@ --- -title: 'The Deal Object - TODO' +title: 'The Deal Object' description: 'Introduction to our CRM `deal` Unified Model' --- diff --git a/docs/crm/engagements/api/create.mdx b/docs/crm/engagements/api/create.mdx new file mode 100644 index 000000000..3b813aaf5 --- /dev/null +++ b/docs/crm/engagements/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create an Engagement' +description: 'Create an Engagement in any CRM Platform using this endpoint' +openapi: "POST /crm/engagement" +--- \ No newline at end of file diff --git a/docs/crm/engagements/api/get.mdx b/docs/crm/engagements/api/get.mdx new file mode 100644 index 000000000..ba11964d7 --- /dev/null +++ b/docs/crm/engagements/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve an Engagement' +description: 'Retrieve an Engagement in any CRM Platform using this endpoint' +openapi: "GET /crm/engagement/{id}" +--- \ No newline at end of file diff --git a/docs/crm/engagements/api/list.mdx b/docs/crm/engagements/api/list.mdx new file mode 100644 index 000000000..e68232d08 --- /dev/null +++ b/docs/crm/engagements/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Engagements' +description: 'List Engagements in any CRM Platform using this endpoint' +openapi: "GET /crm/engagement" +--- \ No newline at end of file diff --git a/docs/crm/engagements/api/update.mdx b/docs/crm/engagements/api/update.mdx new file mode 100644 index 000000000..72d5222a8 --- /dev/null +++ b/docs/crm/engagements/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update an Engagement' +description: 'Update an Engagement in any CRM Platform using this endpoint' +openapi: "PATCH /crm/engagement" +--- \ No newline at end of file diff --git a/docs/crm/notes/api/create.mdx b/docs/crm/notes/api/create.mdx new file mode 100644 index 000000000..0626fd2dc --- /dev/null +++ b/docs/crm/notes/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create a Note' +description: 'Create a Note in any CRM Platform using this endpoint' +openapi: "POST /crm/note" +--- \ No newline at end of file diff --git a/docs/crm/notes/api/get.mdx b/docs/crm/notes/api/get.mdx new file mode 100644 index 000000000..d1690c6ab --- /dev/null +++ b/docs/crm/notes/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a Note' +description: 'Retrieve a Note in any CRM Platform using this endpoint' +openapi: "GET /crm/note/{id}" +--- \ No newline at end of file diff --git a/docs/crm/notes/api/list.mdx b/docs/crm/notes/api/list.mdx new file mode 100644 index 000000000..39b344e72 --- /dev/null +++ b/docs/crm/notes/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Notes' +description: 'List Notes in any CRM Platform using this endpoint' +openapi: "GET /crm/note" +--- \ No newline at end of file diff --git a/docs/crm/notes/api/update.mdx b/docs/crm/notes/api/update.mdx new file mode 100644 index 000000000..4a2038642 --- /dev/null +++ b/docs/crm/notes/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a Note' +description: 'Update a Note in any CRM Platform using this endpoint' +openapi: "PATCH /crm/note" +--- \ No newline at end of file diff --git a/docs/crm/tasks/api/create.mdx b/docs/crm/tasks/api/create.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/docs/crm/tasks/api/get.mdx b/docs/crm/tasks/api/get.mdx new file mode 100644 index 000000000..cdec289dc --- /dev/null +++ b/docs/crm/tasks/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a Task' +description: 'List Task in any CRM Platform using this endpoint' +openapi: "GET /crm/task/{id}" +--- \ No newline at end of file diff --git a/docs/crm/tasks/api/list.mdx b/docs/crm/tasks/api/list.mdx new file mode 100644 index 000000000..61523dc02 --- /dev/null +++ b/docs/crm/tasks/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Tasks' +description: 'List Tasks in any CRM Platform using this endpoint' +openapi: "GET /crm/task" +--- \ No newline at end of file diff --git a/docs/crm/tasks/api/update.mdx b/docs/crm/tasks/api/update.mdx new file mode 100644 index 000000000..fa5c21f84 --- /dev/null +++ b/docs/crm/tasks/api/update.mdx @@ -0,0 +1,3 @@ +--- +openapi: "PATCH /crm/task" +--- \ No newline at end of file diff --git a/docs/crm/users/api/get.mdx b/docs/crm/users/api/get.mdx new file mode 100644 index 000000000..ebc0a61bb --- /dev/null +++ b/docs/crm/users/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a User' +description: 'Retrieve a User in any CRM Platform using this endpoint' +openapi: "GET /crm/user/{id}" +--- \ No newline at end of file diff --git a/docs/crm/users/api/list.mdx b/docs/crm/users/api/list.mdx new file mode 100644 index 000000000..b897ab6df --- /dev/null +++ b/docs/crm/users/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Users' +description: 'List Users in any CRM Platform using this endpoint' +openapi: "GET /crm/user" +--- \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index 3bd840b18..b263bcfaf 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -82,25 +82,29 @@ "group": "Contacts", "pages": [ "crm/contacts/overview", "crm/contacts/api/list", "crm/contacts/api/get", "crm/contacts/api/create", "crm/contacts/api/update" ] }, + { + "group": "Companies", + "pages": [ "crm/companies/overview", "crm/companies/api/list", "crm/companies/api/get", "crm/companies/api/create", "crm/companies/api/update" ] + }, { "group": "Deals", - "pages": [ "crm/deals/overview" ] + "pages": [ "crm/deals/overview", "crm/deals/api/list", "crm/deals/api/get", "crm/deals/api/create", "crm/deals/api/update" ] }, { "group": "Notes", - "pages": [ "crm/notes/overview" ] + "pages": [ "crm/notes/overview", "crm/notes/api/list", "crm/notes/api/get", "crm/notes/api/create", "crm/notes/api/update" ] }, { "group": "Engagements", - "pages": [ "crm/engagements/overview" ] + "pages": [ "crm/engagements/overview", "crm/engagements/api/list", "crm/engagements/api/get", "crm/engagements/api/create", "crm/engagements/api/update" ] }, { "group": "Tasks", - "pages": [ "crm/tasks/overview" ] + "pages": [ "crm/tasks/overview", "crm/tasks/api/list", "crm/tasks/api/get"] }, { "group": "Users", - "pages": [ "crm/users/overview" ] + "pages": [ "crm/users/overview", "crm/users/api/list", "crm/users/api/get" ] } ] }, @@ -117,31 +121,31 @@ "ticketing/try", { "group": "Tickets", - "pages": [ "ticketing/tickets/overview", "ticketing/tickets/api/get", "ticketing/tickets/api/post" ] + "pages": [ "ticketing/tickets/overview", "ticketing/tickets/api/list" , "ticketing/tickets/api/get", "ticketing/tickets/api/create", "ticketing/tickets/api/update" ] }, { "group": "Comments", - "pages": [ "ticketing/comments/overview", "ticketing/comments/api/get", "ticketing/comments/api/post" ] + "pages": [ "ticketing/comments/overview", "ticketing/comments/api/list", "ticketing/comments/api/get", "ticketing/comments/api/create", "ticketing/comments/api/update" ] }, { "group": "Users", - "pages": [ "ticketing/users/overview", "ticketing/users/api/get", "ticketing/users/api/post" ] + "pages": [ "ticketing/users/overview", "ticketing/users/api/list", "ticketing/users/api/get" ] }, { "group": "Contacts", - "pages": [ "ticketing/contacts/overview", "ticketing/contacts/api/get", "ticketing/contacts/api/post" ] + "pages": [ "ticketing/contacts/overview", "ticketing/contacts/api/list", "ticketing/contacts/api/get", "ticketing/contacts/api/create", "ticketing/contacts/api/update" ] }, { "group": "Accounts", - "pages": [ "ticketing/accounts/overview", "ticketing/accounts/api/get", "ticketing/accounts/api/post" ] + "pages": [ "ticketing/accounts/overview", "ticketing/accounts/api/list", "ticketing/accounts/api/get", "ticketing/accounts/api/create", "ticketing/accounts/api/update" ] }, { "group": "Tags", - "pages": [ "ticketing/tags/overview", "ticketing/tags/api/get", "ticketing/tags/api/post" ] + "pages": [ "ticketing/tags/overview", "ticketing/tags/api/list", "ticketing/tags/api/get" ] }, { "group": "Teams", - "pages": [ "ticketing/teams/overview", "ticketing/teams/api/get", "ticketing/teams/api/post" ] + "pages": [ "ticketing/teams/overview", "ticketing/teams/api/list", "ticketing/teams/api/get" ] } ] }, @@ -149,226 +153,223 @@ { "group": "API Reference", "pages": - [ - { - "group": "auth", - "pages": [ - "api-reference/auth/register", - "api-reference/auth/log-in", - "api-reference/auth/get-users", - "api-reference/auth/retrieve-api-keys", - "api-reference/auth/create-api-key" - ] - }, - { - "group": "connections", - "pages": [ - "api-reference/connections/capture-oauth-callback", - "api-reference/connections/list-connections" - ] - }, - { - "group": "webhook", - "pages": [ - "api-reference/webhook/retrieve-webhooks-metadata", - "api-reference/webhook/add-webhook-metadata", - "api-reference/webhook/update-webhook-status" - ] - }, - { - "group": "linked-users", - "pages": [ - "api-reference/linked-users/add-linked-user", - "api-reference/linked-users/retrieve-linked-users", - "api-reference/linked-users/retrieve-a-linked-user" - ] - }, - { - "group": "organisations", - "pages": [ - "api-reference/organisations/retrieve-organisations", - "api-reference/organisations/create-an-organisation" - ] - }, - { - "group": "projects", - "pages": [ - "api-reference/projects/retrieve-projects", - "api-reference/projects/create-a-project" - ] - }, - { - "group": "field-mapping", - "pages": [ - "api-reference/field-mapping/retrieve-field-mapping-entities", - "api-reference/field-mapping/retrieve-field-mappings", - "api-reference/field-mapping/retrieve-field-mappings-values", - "api-reference/field-mapping/define-target-field", - "api-reference/field-mapping/map-custom-field", - "api-reference/field-mapping/retrieve-custom-properties" - ] - }, - { - "group": "events", - "pages": [ - "api-reference/events/retrieve-events" - ] - }, - { - "group": "magic-link", - "pages": [ - "api-reference/magic-link/create-a-magic-link", - "api-reference/magic-link/retrieve-magic-links", - "api-reference/magic-link/retrieve-a-magic-link" - ] - }, - { - "group": "passthrough", - "pages": [ - "api-reference/passthrough/make-a-passthrough-request" - ] - }, - - { - "group": "crm/contact", - "pages": [ - "api-reference/crmcontact/list-a-batch-of-crm-contacts", - "api-reference/crmcontact/create-crm-contact", - "api-reference/crmcontact/update-a-crm-contact", - "api-reference/crmcontact/retrieve-a-crm-contact", - "api-reference/crmcontact/add-a-batch-of-crm-contacts" - ] - }, - { - "group": "crm/deal", - "pages": [ - "api-reference/crmdeal/list-a-batch-of-deals", - "api-reference/crmdeal/create-a-deal", - "api-reference/crmdeal/retrieve-a-deal", - "api-reference/crmdeal/update-a-deal", - "api-reference/crmdeal/add-a-batch-of-deals" - ] - }, - { - "group": "crm/note", - "pages": [ - "api-reference/crmnote/list-a-batch-of-notes", - "api-reference/crmnote/create-a-note", - "api-reference/crmnote/retrieve-a-note", - "api-reference/crmnote/add-a-batch-of-notes" - ] - }, - { - "group": "crm/company", - "pages": [ - "api-reference/crmcompany/list-a-batch-of-companies", - "api-reference/crmcompany/create-a-company", - "api-reference/crmcompany/update-a-company", - "api-reference/crmcompany/retrieve-a-company", - "api-reference/crmcompany/add-a-batch-of-companies" - ] - }, - { - "group": "crm/engagement", - "pages": [ - "api-reference/crmengagement/list-a-batch-of-engagements", - "api-reference/crmengagement/create-a-engagement", - "api-reference/crmengagement/update-a-engagement", - "api-reference/crmengagement/retrieve-a-engagement", - "api-reference/crmengagement/add-a-batch-of-engagements" - ] - }, - { - "group": "crm/stage", - "pages": [ - "api-reference/crmstage/list-a-batch-of-stages", - "api-reference/crmstage/retrieve-a-stage" - ] - }, - { - "group": "crm/task", - "pages": [ - "api-reference/crmtask/list-a-batch-of-tasks", - "api-reference/crmtask/create-a-task", - "api-reference/crmtask/update-a-task", - "api-reference/crmtask/retrieve-a-task", - "api-reference/crmtask/add-a-batch-of-tasks" - ] - }, - { - "group": "crm/user", - "pages": [ - "api-reference/crmuser/list-a-batch-of-users", - "api-reference/crmuser/retrieve-a-user" - ] - }, - - - { - "group": "ticketing/ticket", - "pages": [ - "api-reference/ticketingticket/list-a-batch-of-tickets", - "api-reference/ticketingticket/create-a-ticket", - "api-reference/ticketingticket/update-a-ticket", - "api-reference/ticketingticket/retrieve-a-ticket", - "api-reference/ticketingticket/add-a-batch-of-tickets" - ] - }, - { - "group": "ticketing/comment", - "pages": [ - "api-reference/ticketingcomment/list-a-batch-of-comments", - "api-reference/ticketingcomment/create-a-comment", - "api-reference/ticketingcomment/retrieve-a-comment", - "api-reference/ticketingcomment/add-a-batch-of-comments" - ] - }, - { - "group": "ticketing/user", - "pages": [ - "api-reference/ticketinguser/list-a-batch-of-users", - "api-reference/ticketinguser/retrieve-a-user" - ] - }, - { - "group": "ticketing/attachment", - "pages": [ - "api-reference/ticketingattachment/list-a-batch-of-attachments", - "api-reference/ticketingattachment/create-a-attachment", - "api-reference/ticketingattachment/retrieve-a-attachment", - "api-reference/ticketingattachment/download-a-attachment", - "api-reference/ticketingattachment/add-a-batch-of-attachments" - ] - }, - { - "group": "ticketing/contact", - "pages": [ - "api-reference/ticketingcontact/list-a-batch-of-contacts", - "api-reference/ticketingcontact/retrieve-a-contact" - ] - }, - { - "group": "ticketing/account", - "pages": [ - "api-reference/ticketingaccount/list-a-batch-of-accounts", - "api-reference/ticketingaccount/retrieve-an-account" - ] - }, - { - "group": "ticketing/tag", - "pages": [ - "api-reference/ticketingtag/list-a-batch-of-tags", - "api-reference/ticketingtag/retrieve-a-tag" - ] - }, - { - "group": "ticketing/team", - "pages": [ - "api-reference/ticketingteam/list-a-batch-of-teams", - "api-reference/ticketingteam/retrieve-a-team" - ] - } - ] + [ + { + "group": "auth", + "pages": [ + "api-reference/auth/register", + "api-reference/auth/log-in", + "api-reference/auth/get-users", + "api-reference/auth/retrieve-api-keys", + "api-reference/auth/create-api-key" + ] + }, + { + "group": "connections", + "pages": [ + "api-reference/connections/capture-oauth-callback", + "api-reference/connections/list-connections" + ] + }, + { + "group": "webhook", + "pages": [ + "api-reference/webhook/retrieve-webhooks-metadata", + "api-reference/webhook/add-webhook-metadata", + "api-reference/webhook/update-webhook-status" + ] + }, + { + "group": "linked-users", + "pages": [ + "api-reference/linked-users/add-linked-user", + "api-reference/linked-users/retrieve-linked-users", + "api-reference/linked-users/retrieve-a-linked-user" + ] + }, + { + "group": "organisations", + "pages": [ + "api-reference/organisations/retrieve-organisations", + "api-reference/organisations/create-an-organisation" + ] + }, + { + "group": "projects", + "pages": [ + "api-reference/projects/retrieve-projects", + "api-reference/projects/create-a-project" + ] + }, + { + "group": "field-mapping", + "pages": [ + "api-reference/field-mapping/retrieve-field-mapping-entities", + "api-reference/field-mapping/retrieve-field-mappings", + "api-reference/field-mapping/retrieve-field-mappings-values", + "api-reference/field-mapping/define-target-field", + "api-reference/field-mapping/map-custom-field", + "api-reference/field-mapping/retrieve-custom-properties" + ] + }, + { + "group": "events", + "pages": [ + "api-reference/events/retrieve-events" + ] + }, + { + "group": "magic-link", + "pages": [ + "api-reference/magic-link/create-a-magic-link", + "api-reference/magic-link/retrieve-magic-links", + "api-reference/magic-link/retrieve-a-magic-link" + ] + }, + { + "group": "passthrough", + "pages": [ + "api-reference/passthrough/make-a-passthrough-request" + ] + }, + { + "group": "crm/contact", + "pages": [ + "api-reference/crmcontact/list-a-batch-of-crm-contacts", + "api-reference/crmcontact/create-crm-contact", + "api-reference/crmcontact/update-a-crm-contact", + "api-reference/crmcontact/retrieve-a-crm-contact", + "api-reference/crmcontact/add-a-batch-of-crm-contacts" + ] + }, + { + "group": "crm/deal", + "pages": [ + "api-reference/crmdeal/list-a-batch-of-deals", + "api-reference/crmdeal/create-a-deal", + "api-reference/crmdeal/retrieve-a-deal", + "api-reference/crmdeal/update-a-deal", + "api-reference/crmdeal/add-a-batch-of-deals" + ] + }, + { + "group": "crm/note", + "pages": [ + "api-reference/crmnote/list-a-batch-of-notes", + "api-reference/crmnote/create-a-note", + "api-reference/crmnote/retrieve-a-note", + "api-reference/crmnote/add-a-batch-of-notes" + ] + }, + { + "group": "crm/company", + "pages": [ + "api-reference/crmcompany/list-a-batch-of-companies", + "api-reference/crmcompany/create-a-company", + "api-reference/crmcompany/update-a-company", + "api-reference/crmcompany/retrieve-a-company", + "api-reference/crmcompany/add-a-batch-of-companies" + ] + }, + { + "group": "crm/engagement", + "pages": [ + "api-reference/crmengagement/list-a-batch-of-engagements", + "api-reference/crmengagement/create-a-engagement", + "api-reference/crmengagement/update-a-engagement", + "api-reference/crmengagement/retrieve-a-engagement", + "api-reference/crmengagement/add-a-batch-of-engagements" + ] + }, + { + "group": "crm/stage", + "pages": [ + "api-reference/crmstage/list-a-batch-of-stages", + "api-reference/crmstage/retrieve-a-stage" + ] + }, + { + "group": "crm/task", + "pages": [ + "api-reference/crmtask/list-a-batch-of-tasks", + "api-reference/crmtask/create-a-task", + "api-reference/crmtask/update-a-task", + "api-reference/crmtask/retrieve-a-task", + "api-reference/crmtask/add-a-batch-of-tasks" + ] + }, + { + "group": "crm/user", + "pages": [ + "api-reference/crmuser/list-a-batch-of-users", + "api-reference/crmuser/retrieve-a-user" + ] + }, + { + "group": "ticketing/ticket", + "pages": [ + "api-reference/ticketingticket/list-a-batch-of-tickets", + "api-reference/ticketingticket/create-a-ticket", + "api-reference/ticketingticket/update-a-ticket", + "api-reference/ticketingticket/retrieve-a-ticket", + "api-reference/ticketingticket/add-a-batch-of-tickets" + ] + }, + { + "group": "ticketing/comment", + "pages": [ + "api-reference/ticketingcomment/list-a-batch-of-comments", + "api-reference/ticketingcomment/create-a-comment", + "api-reference/ticketingcomment/retrieve-a-comment", + "api-reference/ticketingcomment/add-a-batch-of-comments" + ] + }, + { + "group": "ticketing/user", + "pages": [ + "api-reference/ticketinguser/list-a-batch-of-users", + "api-reference/ticketinguser/retrieve-a-user" + ] + }, + { + "group": "ticketing/attachment", + "pages": [ + "api-reference/ticketingattachment/list-a-batch-of-attachments", + "api-reference/ticketingattachment/create-a-attachment", + "api-reference/ticketingattachment/retrieve-a-attachment", + "api-reference/ticketingattachment/download-a-attachment", + "api-reference/ticketingattachment/add-a-batch-of-attachments" + ] + }, + { + "group": "ticketing/contact", + "pages": [ + "api-reference/ticketingcontact/list-a-batch-of-contacts", + "api-reference/ticketingcontact/retrieve-a-contact" + ] + }, + { + "group": "ticketing/account", + "pages": [ + "api-reference/ticketingaccount/list-a-batch-of-accounts", + "api-reference/ticketingaccount/retrieve-an-account" + ] + }, + { + "group": "ticketing/tag", + "pages": [ + "api-reference/ticketingtag/list-a-batch-of-tags", + "api-reference/ticketingtag/retrieve-a-tag" + ] + }, + { + "group": "ticketing/team", + "pages": [ + "api-reference/ticketingteam/list-a-batch-of-teams", + "api-reference/ticketingteam/retrieve-a-team" + ] + } + ] }, { "group": "Core Concepts", diff --git a/docs/open-source/contributors.mdx b/docs/open-source/contributors.mdx index 30c556c56..cfb47c8af 100644 --- a/docs/open-source/contributors.mdx +++ b/docs/open-source/contributors.mdx @@ -27,6 +27,12 @@ We made a docker file that builds Panora from sources, specifically to help you ``` + + ```bash + rm -rf node_modules .pnpm_store ./packages/api/dist ./packages/api/node_modules ./apps/webapp/node_modules ./apps/frontend_snippet/node_modules + ``` + + ```bash echo "node-linker=hoisted" > .npmrc diff --git a/docs/ticketing/accounts/api/create.mdx b/docs/ticketing/accounts/api/create.mdx new file mode 100644 index 000000000..e9ee231be --- /dev/null +++ b/docs/ticketing/accounts/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create an accont' +description: 'Create an account in any Ticketing Platform using this endpoint' +openapi: "POST /ticketing/account" +--- \ No newline at end of file diff --git a/docs/ticketing/accounts/api/get.mdx b/docs/ticketing/accounts/api/get.mdx new file mode 100644 index 000000000..baeea1221 --- /dev/null +++ b/docs/ticketing/accounts/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve an accont' +description: 'Retrieve an account in any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/account/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/accounts/api/list.mdx b/docs/ticketing/accounts/api/list.mdx new file mode 100644 index 000000000..094110899 --- /dev/null +++ b/docs/ticketing/accounts/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List all acconts' +description: 'List all accounts in any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/account" +--- \ No newline at end of file diff --git a/docs/ticketing/accounts/api/update.mdx b/docs/ticketing/accounts/api/update.mdx new file mode 100644 index 000000000..e67b24d22 --- /dev/null +++ b/docs/ticketing/accounts/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update an accont' +description: 'Update an account in any Ticketing Platform using this endpoint' +openapi: "PATCH /ticketing/account" +--- \ No newline at end of file diff --git a/docs/ticketing/comments/api/post.mdx b/docs/ticketing/comments/api/create.mdx similarity index 100% rename from docs/ticketing/comments/api/post.mdx rename to docs/ticketing/comments/api/create.mdx diff --git a/docs/ticketing/comments/api/list.mdx b/docs/ticketing/comments/api/list.mdx index dd65c6645..cc1c10876 100644 --- a/docs/ticketing/comments/api/list.mdx +++ b/docs/ticketing/comments/api/list.mdx @@ -1,5 +1,5 @@ --- title: 'List Comments' -description: 'Loist comments in any Ticketing Platform using this endpoint' +description: 'List comments in any Ticketing connection using this endpoint' openapi: "GET /ticketing/comment" --- \ No newline at end of file diff --git a/docs/ticketing/comments/api/update.mdx b/docs/ticketing/comments/api/update.mdx new file mode 100644 index 000000000..ea416476b --- /dev/null +++ b/docs/ticketing/comments/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a Comment' +description: 'Update a comment in any Ticketing connection using this endpoint' +openapi: "PATCH /ticketing/comment" +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/api/create.mdx b/docs/ticketing/contacts/api/create.mdx new file mode 100644 index 000000000..ebc8cac2d --- /dev/null +++ b/docs/ticketing/contacts/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create a Contact' +description: 'Create a contact in any Ticketing Platform using this endpoint' +openapi: "POST /ticketing/contact" +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/api/get.mdx b/docs/ticketing/contacts/api/get.mdx new file mode 100644 index 000000000..786fc16c4 --- /dev/null +++ b/docs/ticketing/contacts/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a Contact' +description: 'Retrieve a contact in any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/contact" +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/api/list.mdx b/docs/ticketing/contacts/api/list.mdx new file mode 100644 index 000000000..fb3ae4d9f --- /dev/null +++ b/docs/ticketing/contacts/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Contacts' +description: 'List all contacts from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/contact/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/contacts/api/update.mdx b/docs/ticketing/contacts/api/update.mdx new file mode 100644 index 000000000..5b9e130d7 --- /dev/null +++ b/docs/ticketing/contacts/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a Contact' +description: 'Update a Contact from any Ticketing Platform using this endpoint' +openapi: "PATCH /ticketing/contact" +--- \ No newline at end of file diff --git a/docs/ticketing/tags/api/get.mdx b/docs/ticketing/tags/api/get.mdx new file mode 100644 index 000000000..24204c4bf --- /dev/null +++ b/docs/ticketing/tags/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a tag' +description: 'Retrieve a tag in any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/tag/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/tags/api/list.mdx b/docs/ticketing/tags/api/list.mdx new file mode 100644 index 000000000..3dddc4f25 --- /dev/null +++ b/docs/ticketing/tags/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List all tags' +description: 'List all tags in any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/tag" +--- \ No newline at end of file diff --git a/docs/ticketing/teams/api/create.mdx b/docs/ticketing/teams/api/create.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/docs/ticketing/teams/api/get.mdx b/docs/ticketing/teams/api/get.mdx new file mode 100644 index 000000000..f4653be8b --- /dev/null +++ b/docs/ticketing/teams/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a Team' +description: 'Retrieve a Team from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/team/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/teams/api/list.mdx b/docs/ticketing/teams/api/list.mdx new file mode 100644 index 000000000..b8a5410a1 --- /dev/null +++ b/docs/ticketing/teams/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Teams' +description: 'List all teams from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/team/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/teams/api/update.mdx b/docs/ticketing/teams/api/update.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/docs/ticketing/tickets/api/create.mdx b/docs/ticketing/tickets/api/create.mdx new file mode 100644 index 000000000..9f23c4236 --- /dev/null +++ b/docs/ticketing/tickets/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: 'Create a Ticket' +description: 'Createa a Ticket in any Ticketing Platform using this endpoint' +openapi: "POST /ticketing/ticket" +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/api/get.mdx b/docs/ticketing/tickets/api/get.mdx index 24fcecf2f..f2906b953 100644 --- a/docs/ticketing/tickets/api/get.mdx +++ b/docs/ticketing/tickets/api/get.mdx @@ -1,5 +1,5 @@ --- -title: 'List Tickets' -description: 'List tickets in any Ticketing Platform using this endpoint' -openapi: "GET /ticketing/ticket" ---- +title: 'Retrieve a Ticket' +description: 'Retrieve a Ticket from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/ticket/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/api/list.mdx b/docs/ticketing/tickets/api/list.mdx new file mode 100644 index 000000000..7ea3dc211 --- /dev/null +++ b/docs/ticketing/tickets/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List Tickets' +description: 'List Tickets from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/ticket" +--- \ No newline at end of file diff --git a/docs/ticketing/tickets/api/post.mdx b/docs/ticketing/tickets/api/post.mdx deleted file mode 100644 index bf1bb7fe6..000000000 --- a/docs/ticketing/tickets/api/post.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'Create a Ticket' -description: 'Create a ticket in any Ticketing Platform using this endpoint' -openapi: "POST /ticketing/ticket" ---- \ No newline at end of file diff --git a/docs/ticketing/tickets/api/update.mdx b/docs/ticketing/tickets/api/update.mdx new file mode 100644 index 000000000..ac12d17fc --- /dev/null +++ b/docs/ticketing/tickets/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a Ticket' +description: 'Update a Ticket from any Ticketing Platform using this endpoint' +openapi: "PATCH /ticketing/ticket" +--- \ No newline at end of file diff --git a/docs/ticketing/users/api/get.mdx b/docs/ticketing/users/api/get.mdx new file mode 100644 index 000000000..862dad4f2 --- /dev/null +++ b/docs/ticketing/users/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: 'Retrieve a user' +description: 'Retrieve a User from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/user/{id}" +--- \ No newline at end of file diff --git a/docs/ticketing/users/api/list.mdx b/docs/ticketing/users/api/list.mdx new file mode 100644 index 000000000..2352df234 --- /dev/null +++ b/docs/ticketing/users/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: 'List users' +description: 'List Users from any Ticketing Platform using this endpoint' +openapi: "GET /ticketing/user" +--- \ No newline at end of file From 4e333c99ef19274b004f54580b957a3219936d52 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Wed, 24 Jan 2024 17:21:10 +0100 Subject: [PATCH 2/6] Update docs/ticketing/accounts/api/get.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/ticketing/accounts/api/get.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ticketing/accounts/api/get.mdx b/docs/ticketing/accounts/api/get.mdx index baeea1221..f7fd57b4d 100644 --- a/docs/ticketing/accounts/api/get.mdx +++ b/docs/ticketing/accounts/api/get.mdx @@ -1,5 +1,5 @@ --- -title: 'Retrieve an accont' +title: 'Retrieve an account' description: 'Retrieve an account in any Ticketing Platform using this endpoint' openapi: "GET /ticketing/account/{id}" --- \ No newline at end of file From cd114ebcb3d1fddb858ea9f9a9ca3024517689d8 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Wed, 24 Jan 2024 17:21:24 +0100 Subject: [PATCH 3/6] Update docs/ticketing/accounts/api/update.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/ticketing/accounts/api/update.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ticketing/accounts/api/update.mdx b/docs/ticketing/accounts/api/update.mdx index e67b24d22..b41d565d0 100644 --- a/docs/ticketing/accounts/api/update.mdx +++ b/docs/ticketing/accounts/api/update.mdx @@ -1,5 +1,5 @@ --- -title: 'Update an accont' +title: 'Update an account' description: 'Update an account in any Ticketing Platform using this endpoint' openapi: "PATCH /ticketing/account" --- \ No newline at end of file From e52163504ed6ef99bbb00e96d56820c6974b3f26 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Wed, 24 Jan 2024 17:22:27 +0100 Subject: [PATCH 4/6] Update docs/ticketing/accounts/api/create.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/ticketing/accounts/api/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ticketing/accounts/api/create.mdx b/docs/ticketing/accounts/api/create.mdx index e9ee231be..4dce822f3 100644 --- a/docs/ticketing/accounts/api/create.mdx +++ b/docs/ticketing/accounts/api/create.mdx @@ -1,5 +1,5 @@ --- -title: 'Create an accont' +title: 'Create an account' description: 'Create an account in any Ticketing Platform using this endpoint' openapi: "POST /ticketing/account" --- \ No newline at end of file From 3c2e402d067ce6fb9f2b5d532ceda5604c16c6f9 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Wed, 24 Jan 2024 17:22:34 +0100 Subject: [PATCH 5/6] Update docs/ticketing/accounts/api/list.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/ticketing/accounts/api/list.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ticketing/accounts/api/list.mdx b/docs/ticketing/accounts/api/list.mdx index 094110899..6e3fc5698 100644 --- a/docs/ticketing/accounts/api/list.mdx +++ b/docs/ticketing/accounts/api/list.mdx @@ -1,5 +1,5 @@ --- -title: 'List all acconts' +title: 'List all accounts' description: 'List all accounts in any Ticketing Platform using this endpoint' openapi: "GET /ticketing/account" --- \ No newline at end of file From ce40a83b0ff6c55c26011084461ac49c727093c4 Mon Sep 17 00:00:00 2001 From: Rachid F <109089247+rflihxyz@users.noreply.github.com> Date: Wed, 24 Jan 2024 17:22:51 +0100 Subject: [PATCH 6/6] Update docs/ticketing/tickets/api/create.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/ticketing/tickets/api/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ticketing/tickets/api/create.mdx b/docs/ticketing/tickets/api/create.mdx index 9f23c4236..f1e7dec29 100644 --- a/docs/ticketing/tickets/api/create.mdx +++ b/docs/ticketing/tickets/api/create.mdx @@ -1,5 +1,5 @@ --- title: 'Create a Ticket' -description: 'Createa a Ticket in any Ticketing Platform using this endpoint' +description: 'Create a Ticket in any Ticketing Platform using this endpoint' openapi: "POST /ticketing/ticket" --- \ No newline at end of file