diff --git a/.dockerignore b/.dockerignore index 33b4e6d5c..a4c01c232 100644 --- a/.dockerignore +++ b/.dockerignore @@ -4,6 +4,8 @@ node_modules/ apps/webapp/node_modules apps/webapp/dist -packages/api/node_modules -packages/api/dist +apps/frontend-snippet/node_modules +apps/frontend-snippet/dist +packages/api/node_modules +packages/api/dist \ No newline at end of file diff --git a/docs/crm/contacts/api/get.mdx b/docs/crm/contacts/api/get.mdx index e7ee16c64..824562d1c 100644 --- a/docs/crm/contacts/api/get.mdx +++ b/docs/crm/contacts/api/get.mdx @@ -1,17 +1,5 @@ --- -title: 'List all contacts' -description: 'Retrieve all contacts from all connected CRMs using one endpoint' -openapi: "GET /crm/contact" +title: 'Retrieve a contact' +description: 'Retrieve a contact from connected CRMs' +openapi: "GET /crm/contact/{id}" --- - -Example API Response: - - -```json JSON -{ - "id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e" - "first_name": "John" - "last_name": "Doe" -} -``` - diff --git a/docs/crm/contacts/api/list.mdx b/docs/crm/contacts/api/list.mdx new file mode 100644 index 000000000..e7ee16c64 --- /dev/null +++ b/docs/crm/contacts/api/list.mdx @@ -0,0 +1,17 @@ +--- +title: 'List all contacts' +description: 'Retrieve all contacts from all connected CRMs using one endpoint' +openapi: "GET /crm/contact" +--- + +Example API Response: + + +```json JSON +{ + "id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e" + "first_name": "John" + "last_name": "Doe" +} +``` + diff --git a/docs/crm/contacts/api/update.mdx b/docs/crm/contacts/api/update.mdx new file mode 100644 index 000000000..22b6f97d9 --- /dev/null +++ b/docs/crm/contacts/api/update.mdx @@ -0,0 +1,5 @@ +--- +title: 'Update a contact' +description: 'Update a contacts from any connected CRM' +openapi: "PATCH /crm/contact" +--- \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index 5eadcaf75..81f311227 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -86,7 +86,7 @@ "crm/catalog", { "group": "Contacts", - "pages": [ "crm/contacts/overview", "crm/contacts/api/get", "crm/contacts/api/create" ] + "pages": [ "crm/contacts/overview", "crm/contacts/api/list", "crm/contacts/api/get", "crm/contacts/api/create", "crm/contacts/api/update" ] }, { "group": "Deals", diff --git a/packages/api/src/crm/contact/contact.controller.ts b/packages/api/src/crm/contact/contact.controller.ts index 2da12677f..498812ac8 100644 --- a/packages/api/src/crm/contact/contact.controller.ts +++ b/packages/api/src/crm/contact/contact.controller.ts @@ -52,9 +52,9 @@ export class ContactController { @ApiOperation({ operationId: 'getContact', summary: 'Retrieve a CRM Contact', - description: 'Retrive a contact in any supported CRM', + description: 'Retrieve a contact from any connected CRM', }) - @ApiParam({ name: 'id', required: true, type: String }) + @ApiParam({ name: 'id', required: true, type: String, description: "id of the `contact` you want to retrive." }) @ApiQuery({ name: 'remote_data', required: false, type: Boolean, description: 'Set to true to include data from the original CRM software.' }) @ApiCustomResponse(ContactResponse) @Get(':id') diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json index cafb9af39..43236595a 100644 --- a/packages/api/swagger/swagger-spec.json +++ b/packages/api/swagger/swagger-spec.json @@ -790,12 +790,13 @@ "get": { "operationId": "getContact", "summary": "Retrieve a CRM Contact", - "description": "Retrive a contact in any supported CRM", + "description": "Retrieve a contact from any connected CRM", "parameters": [ { "name": "id", "required": true, "in": "path", + "description": "id of the `contact` you want to retrive.", "schema": { "type": "string" }