diff --git a/docs/api-reference/ticketinguser/list-a-batch-of-users.mdx b/docs/api-reference/ticketinguser/list-a-batch-of-users.mdx index 2c339b395..11d334471 100644 --- a/docs/api-reference/ticketinguser/list-a-batch-of-users.mdx +++ b/docs/api-reference/ticketinguser/list-a-batch-of-users.mdx @@ -1,3 +1,3 @@ --- -openapi: get /ticketing/users +openapi: get /ticketing/userss --- diff --git a/docs/api-reference/ticketinguser/retrieve-a-user.mdx b/docs/api-reference/ticketinguser/retrieve-a-user.mdx index 0bdd75f2f..971a84e79 100644 --- a/docs/api-reference/ticketinguser/retrieve-a-user.mdx +++ b/docs/api-reference/ticketinguser/retrieve-a-user.mdx @@ -1,3 +1,3 @@ --- -openapi: get /ticketing/users/{id} +openapi: get /ticketing/userss/{id} --- diff --git a/docs/crm/companies/api/create.mdx b/docs/crm/companies/api/create.mdx new file mode 100644 index 000000000..1d72c6c64 --- /dev/null +++ b/docs/crm/companies/api/create.mdx @@ -0,0 +1,4 @@ +--- +title: "Create a company" +openapi: "POST /crm/companies" +--- diff --git a/docs/crm/companies/api/get.mdx b/docs/crm/companies/api/get.mdx new file mode 100644 index 000000000..d4a4e0ca5 --- /dev/null +++ b/docs/crm/companies/api/get.mdx @@ -0,0 +1,4 @@ +--- +title: "Retrieve a company" +openapi: "GET /crm/companies/{id}" +--- diff --git a/docs/crm/companies/api/list.mdx b/docs/crm/companies/api/list.mdx new file mode 100644 index 000000000..5e6675c19 --- /dev/null +++ b/docs/crm/companies/api/list.mdx @@ -0,0 +1,4 @@ +--- +title: "List companies" +openapi: "GET /crm/companies" +--- diff --git a/docs/crm/companies/api/update.mdx b/docs/crm/companies/api/update.mdx new file mode 100644 index 000000000..ca5c05642 --- /dev/null +++ b/docs/crm/companies/api/update.mdx @@ -0,0 +1,4 @@ +--- +title: "Update a company" +openapi: "PATCH /crm/companies" +--- 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/deals/api/create.mdx b/docs/crm/deals/api/create.mdx new file mode 100644 index 000000000..bf916ba13 --- /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/deals" +--- diff --git a/docs/crm/deals/api/get.mdx b/docs/crm/deals/api/get.mdx new file mode 100644 index 000000000..c58dd2951 --- /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/deals/{id}" +--- diff --git a/docs/crm/deals/api/list.mdx b/docs/crm/deals/api/list.mdx new file mode 100644 index 000000000..ee1526568 --- /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/deals" +--- diff --git a/docs/crm/deals/api/update.mdx b/docs/crm/deals/api/update.mdx new file mode 100644 index 000000000..5a9b79a29 --- /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/deals" +--- 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..022cb00e4 --- /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/engagements" +--- diff --git a/docs/crm/engagements/api/get.mdx b/docs/crm/engagements/api/get.mdx new file mode 100644 index 000000000..b9e6ae334 --- /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/engagements/{id}" +--- diff --git a/docs/crm/engagements/api/list.mdx b/docs/crm/engagements/api/list.mdx new file mode 100644 index 000000000..31be783fc --- /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/engagements" +--- diff --git a/docs/crm/engagements/api/update.mdx b/docs/crm/engagements/api/update.mdx new file mode 100644 index 000000000..579f6546b --- /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/engagements" +--- diff --git a/docs/crm/notes/api/create.mdx b/docs/crm/notes/api/create.mdx new file mode 100644 index 000000000..2be36e5ef --- /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/notes" +--- diff --git a/docs/crm/notes/api/get.mdx b/docs/crm/notes/api/get.mdx new file mode 100644 index 000000000..acdc60bd5 --- /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/notes/{id}" +--- diff --git a/docs/crm/notes/api/list.mdx b/docs/crm/notes/api/list.mdx new file mode 100644 index 000000000..d9c72fb9f --- /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/notes" +--- diff --git a/docs/crm/notes/api/update.mdx b/docs/crm/notes/api/update.mdx new file mode 100644 index 000000000..5f20e79f1 --- /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/notes" +--- 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..8d237d5df --- /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/tasks/{id}" +--- diff --git a/docs/crm/tasks/api/list.mdx b/docs/crm/tasks/api/list.mdx new file mode 100644 index 000000000..f070d1d3a --- /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/tasks" +--- diff --git a/docs/crm/tasks/api/update.mdx b/docs/crm/tasks/api/update.mdx new file mode 100644 index 000000000..cc28bd8d8 --- /dev/null +++ b/docs/crm/tasks/api/update.mdx @@ -0,0 +1,3 @@ +--- +openapi: "PATCH /crm/tasks" +--- diff --git a/docs/crm/users/api/get.mdx b/docs/crm/users/api/get.mdx new file mode 100644 index 000000000..c07c248b5 --- /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/users/{id}" +--- diff --git a/docs/crm/users/api/list.mdx b/docs/crm/users/api/list.mdx new file mode 100644 index 000000000..fbb04d722 --- /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/users" +--- 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 c8af9f1b1..ea136ded8 100644 --- a/docs/open-source/contributors.mdx +++ b/docs/open-source/contributors.mdx @@ -21,6 +21,13 @@ We made a docker file that builds Panora from sources, specifically to help you ```bash cp .env.example .env ``` +{" "} + + ```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..c4c74be0d --- /dev/null +++ b/docs/ticketing/accounts/api/create.mdx @@ -0,0 +1,5 @@ +--- +title: "Create an account" +description: "Create an account in any Ticketing Platform using this endpoint" +openapi: "POST /ticketing/accounts" +--- diff --git a/docs/ticketing/accounts/api/get.mdx b/docs/ticketing/accounts/api/get.mdx new file mode 100644 index 000000000..a4098166f --- /dev/null +++ b/docs/ticketing/accounts/api/get.mdx @@ -0,0 +1,5 @@ +--- +title: "Retrieve an account" +description: "Retrieve an account in any Ticketing Platform using this endpoint" +openapi: "GET /ticketing/accounts/{id}" +--- diff --git a/docs/ticketing/accounts/api/list.mdx b/docs/ticketing/accounts/api/list.mdx new file mode 100644 index 000000000..5e2401b31 --- /dev/null +++ b/docs/ticketing/accounts/api/list.mdx @@ -0,0 +1,5 @@ +--- +title: "List all accounts" +description: "List all accounts in any Ticketing Platform using this endpoint" +openapi: "GET /ticketing/accounts" +--- diff --git a/docs/ticketing/accounts/api/update.mdx b/docs/ticketing/accounts/api/update.mdx new file mode 100644 index 000000000..44f747c5d --- /dev/null +++ b/docs/ticketing/accounts/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: "Update an account" +description: "Update an account in any Ticketing Platform using this endpoint" +openapi: "PATCH /ticketing/accounts" +--- 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 1514cf45e..de1ba152e 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 Platform using this endpoint" openapi: "GET /ticketing/comments" --- diff --git a/docs/ticketing/comments/api/update.mdx b/docs/ticketing/comments/api/update.mdx new file mode 100644 index 000000000..b49d113f0 --- /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/comments" +--- diff --git a/docs/ticketing/contacts/api/create.mdx b/docs/ticketing/contacts/api/create.mdx new file mode 100644 index 000000000..15fea705a --- /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/contacts" +--- diff --git a/docs/ticketing/contacts/api/get.mdx b/docs/ticketing/contacts/api/get.mdx new file mode 100644 index 000000000..6324a76dd --- /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/contacts" +--- diff --git a/docs/ticketing/contacts/api/list.mdx b/docs/ticketing/contacts/api/list.mdx new file mode 100644 index 000000000..460724f0e --- /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/contacts/{id}" +--- diff --git a/docs/ticketing/contacts/api/update.mdx b/docs/ticketing/contacts/api/update.mdx new file mode 100644 index 000000000..17a38c7b9 --- /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/contacts" +--- diff --git a/docs/ticketing/tags/api/get.mdx b/docs/ticketing/tags/api/get.mdx new file mode 100644 index 000000000..dd5961e6e --- /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/tags/{id}" +--- diff --git a/docs/ticketing/tags/api/list.mdx b/docs/ticketing/tags/api/list.mdx new file mode 100644 index 000000000..3d9220e77 --- /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/tags" +--- 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..3c23cadd1 --- /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/teams/{id}" +--- diff --git a/docs/ticketing/teams/api/list.mdx b/docs/ticketing/teams/api/list.mdx new file mode 100644 index 000000000..2b787d553 --- /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/teams/{id}" +--- 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/post.mdx b/docs/ticketing/tickets/api/create.mdx similarity index 100% rename from docs/ticketing/tickets/api/post.mdx rename to docs/ticketing/tickets/api/create.mdx diff --git a/docs/ticketing/tickets/api/list.mdx b/docs/ticketing/tickets/api/list.mdx new file mode 100644 index 000000000..34b2de223 --- /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/tickets" +--- diff --git a/docs/ticketing/tickets/api/update.mdx b/docs/ticketing/tickets/api/update.mdx new file mode 100644 index 000000000..9d8d0f6c8 --- /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/tickets" +--- diff --git a/docs/ticketing/users/api/get.mdx b/docs/ticketing/users/api/get.mdx new file mode 100644 index 000000000..d30996bf3 --- /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/users/{id}" +--- diff --git a/docs/ticketing/users/api/list.mdx b/docs/ticketing/users/api/list.mdx new file mode 100644 index 000000000..eb9539749 --- /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/users" +--- diff --git a/docs/webhooks/events/event-types.mdx b/docs/webhooks/events/event-types.mdx index e900fd857..3d807c703 100644 --- a/docs/webhooks/events/event-types.mdx +++ b/docs/webhooks/events/event-types.mdx @@ -103,13 +103,13 @@ You’ll notice that these events follow a pattern: resource.event. Our goal is - Occurs whenever a user has been created in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/userss/overview) + Occurs whenever a user has been created in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/usersss/overview) - Occurs whenever a user has been updated in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/userss/overview) + Occurs whenever a user has been updated in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/usersss/overview) - Occurs whenever a user has been deleted in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/userss/overview) + Occurs whenever a user has been deleted in a Ticketing software. The **data** field is a [`Ticketing User`](/ticketing/usersss/overview) diff --git a/packages/api/src/ticketing/user/services/user.service.ts b/packages/api/src/ticketing/user/services/user.service.ts index 329643462..7f21fa23d 100644 --- a/packages/api/src/ticketing/user/services/user.service.ts +++ b/packages/api/src/ticketing/user/services/user.service.ts @@ -152,7 +152,7 @@ export class UserService { status: 'success', type: 'ticketing.user.pull', method: 'GET', - url: '/ticketing/users', + url: '/ticketing/userss', provider: integrationId, direction: '0', timestamp: new Date(), diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json index 008e9aab3..e1117f02b 100644 --- a/packages/api/swagger/swagger-spec.json +++ b/packages/api/swagger/swagger-spec.json @@ -2906,7 +2906,7 @@ ] } }, - "/ticketing/users": { + "/ticketing/userss": { "get": { "operationId": "getUsers", "summary": "List a batch of Users", @@ -2958,7 +2958,7 @@ ] } }, - "/ticketing/users/{id}": { + "/ticketing/userss/{id}": { "get": { "operationId": "getUser", "summary": "Retrieve a User",