Merge pull request #740 from teamleadercrm/ATL-116-calls-add

apiary.apib

@@ -427,6 +427,9 @@ We list all backwards-compatible additions here. These are currently available i
 (There is also a [list of backwards-incompatible upgrades](#changelog) available, but those only apply if you [upgrade your API version](#upgrading-your-api-version).)
 
 #### November 2023
+- We added the `calls.add`, `calls.list`, `calls.info` and `calls.complete` endpoints.
+- We added the `callOutcomes.list` endpoint.
+- We added `call.added`, `call.updated` and `call.deleted` types to supported Webhook types.
 - We added `custom_fields` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`
 
 #### October 2023
@@ -3318,6 +3321,184 @@ Get information about a meeting.
                     + open
                     + done
 
+## Calls [/calls]
+
+### calls.list [POST /calls.list]
+
+Get a list of calls.
+
++ Request (application/json)
+    + Attributes (object)
+        + filter (object, optional)
+            + scheduled_after: `2021-11-21` (string) - Filter on calls occurring on or after a given date
+            + scheduled_before: `2022-05-13` (string) - Filter on calls occurring on or before a given date
+            + relates_to (object, optional) - Filter calls by related object (currently only companies allowed)
+                + id: `415fa7e0-e319-0952-b973-f067f2b49d56` (string)
+                + type: `company` (string)
+            + call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on completed calls by outcome
+        + page (object, optional)
+            + size: `20` (number, optional) - The amount of entries returned per request, max 1 to 100
+                + Default: `20`
+            + number: `1` (number, optional) - The current page, the first page is 1
+                + Default: `1`
+
++ Response 200 (application/json)
+
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + added_at: `2021-11-21T18:14:15+00:00` (string, nullable)
+                + participant (object, nullable)
+                    + customer (object, nullable)
+                        + type: `company` (string)
+                        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                    + contact (object, nullable)
+                        + type: `contact` (string)
+                        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + description: `Call with customer` (string, nullable)
+                + outcome (object, nullable)
+                    + type: `callOutcome` (string)
+                    + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + outcome_summary: `Called, but was not available` (string, nullable)
+                + assignee (object, nullable)
+                    + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+                    + type: `user` (string)
+                + scheduled_at: `2021-11-21T19:14:15+00:00` (string)
+                + status: `open` (enum[string])
+                    + Members
+                        + `open`
+                        + `completed`
+        + meta (object) - Only included with request parameter `includes=pagination`
+            + page (Pagination)
+            + matches: `12` (number)
+
+### calls.info [POST /calls.info]
+
+Get information about a call.
+
++ Request (application/json)
+
+    + Attributes (object)
+        + id: `6fac0bf0-e803-424e-af67-76863a3d7d16` (string, required)
+
++ Response 200 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+            + added_at: `2016-02-01T16:44:33+00:00` (string, nullable)
+            + completed_at: `2016-02-04T16:44:33+00:00` (string, nullable)
+            + participant (object, nullable)
+                + customer (object, nullable)
+                    + type: `company` (string)
+                    + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+                + contact (object, nullable)
+                    + type: `contact` (string)
+                    + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+            + description: `Description of the call` (string, nullable)
+            + outcome (object, nullable)
+                + type: `callOutcome` (string)
+                + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+            + outcome_summary: `Called, but was not available` (string, nullable)
+            + assignee (object, nullable)
+                + type: `user` (string)
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+            + scheduled_at: `2016-02-04T16:00:00+00:00` (string)
+            + status: `open` (enum[string])
+                + Members
+                    + `open`
+                    + `completed`
+            + custom_fields (array[CustomField])
+
+### calls.add [POST /calls.add]
+
+Add a new call.
+
++ Request (application/json)
+
+    + Attributes
+        + description: `Description of the call` (string, optional)
+        + participant (object, required)
+            + customer (object, required)
+                + type (enum, required)
+                    + Members
+                        + company
+                        + contact
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)
+        + due_at: `2016-02-04T16:00:00+00:00` (string, required)
+        + assignee (object, required)
+            + type (enum, required)
+                + Members
+                    + user
+            + id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+        + custom_fields (array[CustomFieldValue], optional)
+
++ Response 201 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + type: `call` (string)
+            + id: `65a35860-dcca-4850-9fd6-47ff08469e0c` (string)
+
+### calls.update [POST /calls.update]
+
+Update a new call.
+
++ Request (application/json)
+
+    + Attributes
+        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, required)
+        + description: `Description of the call` (string, optional)
+        + participant (object, optional)
+            + customer (object, optional)
+                + type (enum, required)
+                    + Members
+                        + company
+                        + contact
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)
+        + due_at: `2016-02-04T16:00:00+00:00` (string, optional)
+        + assignee (object, optional)
+            + type (enum, required)
+                + Members
+                    + user
+            + id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+        + custom_fields (array[CustomFieldValue], optional)
+
++ Response 204 (application/json)
+
+### calls.complete [POST /calls.complete]
+
+Mark a call as complete.
+
++ Request (application/json)
+
+    + Attributes (object)
+        + id: `6fac0bf0-e803-424e-af67-76863a3d7d16` (string, required)
+        + call_outcome_id: `2b43633b-22d1-41b6-b87b-e1fd742325d4` (string, optional)
+        + outcome_summary: `Called, but was not available` (string, optional)
+
++ Response 204 (application/json)
+
+## Call Outcomes [/callOutcomes]
+
+### callOutcomes.list [GET /callOutcomes.list]
+
++ Request (application/json)
+    + Attributes (object)
+        + page (object, optional)
+            + size: `20` (number, optional)
+                + Default: `20`
+            + number: `1` (number, optional)
+                + Default: `1`
+
++ Response 200 (application/json)
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `2b43633b-22d1-41b6-b87b-e1fd742325d4` (string)
+                + name: `Foo Bar` (string)
+
 # Group Invoicing
 
 ## Invoices [/invoices]
@@ -7760,6 +7941,9 @@ Fetch cloudPlatform url for type and id
     + Members
         + account.deactivated
         + account.deleted
+        + call.added
+        + call.updated
+        + call.deleted
         + company.added
         + company.deleted
         + company.updated

src/04-calendar/call-outcomes.apib

@@ -0,0 +1,18 @@
+## Call Outcomes [/callOutcomes]
+
+### callOutcomes.list [GET /callOutcomes.list]
+
++ Request (application/json)
+    + Attributes (object)
+        + page (object, optional)
+            + size: `20` (number, optional)
+                + Default: `20`
+            + number: `1` (number, optional)
+                + Default: `1`
+
++ Response 200 (application/json)
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `2b43633b-22d1-41b6-b87b-e1fd742325d4` (string)
+                + name: `Foo Bar` (string)

src/04-calendar/calls.apib

@@ -0,0 +1,158 @@
+## Calls [/calls]
+
+### calls.list [POST /calls.list]
+
+Get a list of calls.
+
++ Request (application/json)
+    + Attributes (object)
+        + filter (object, optional)
+            + scheduled_after: `2021-11-21` (string) - Filter on calls occurring on or after a given date
+            + scheduled_before: `2022-05-13` (string) - Filter on calls occurring on or before a given date
+            + relates_to (object, optional) - Filter calls by related object (currently only companies allowed)
+                + id: `415fa7e0-e319-0952-b973-f067f2b49d56` (string)
+                + type: `company` (string)
+            + call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on completed calls by outcome
+        + page (object, optional)
+            + size: `20` (number, optional) - The amount of entries returned per request, max 1 to 100
+                + Default: `20`
+            + number: `1` (number, optional) - The current page, the first page is 1
+                + Default: `1`
+
++ Response 200 (application/json)
+
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + added_at: `2021-11-21T18:14:15+00:00` (string, nullable)
+                + participant (object, nullable)
+                    + customer (object, nullable)
+                        + type: `company` (string)
+                        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                    + contact (object, nullable)
+                        + type: `contact` (string)
+                        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + description: `Call with customer` (string, nullable)
+                + outcome (object, nullable)
+                    + type: `callOutcome` (string)
+                    + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+                + outcome_summary: `Called, but was not available` (string, nullable)
+                + assignee (object, nullable)
+                    + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+                    + type: `user` (string)
+                + scheduled_at: `2021-11-21T19:14:15+00:00` (string)
+                + status: `open` (enum[string])
+                    + Members
+                        + `open`
+                        + `completed`
+        + meta (object) - Only included with request parameter `includes=pagination`
+            + page (Pagination)
+            + matches: `12` (number)
+
+### calls.info [POST /calls.info]
+
+Get information about a call.
+
++ Request (application/json)
+
+    + Attributes (object)
+        + id: `6fac0bf0-e803-424e-af67-76863a3d7d16` (string, required)
+
++ Response 200 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+            + added_at: `2016-02-01T16:44:33+00:00` (string, nullable)
+            + completed_at: `2016-02-04T16:44:33+00:00` (string, nullable)
+            + participant (object, nullable)
+                + customer (object, nullable)
+                    + type: `company` (string)
+                    + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+                + contact (object, nullable)
+                    + type: `contact` (string)
+                    + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+            + description: `Description of the call` (string, nullable)
+            + outcome (object, nullable)
+                + type: `callOutcome` (string)
+                + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string)
+            + outcome_summary: `Called, but was not available` (string, nullable)
+            + assignee (object, nullable)
+                + type: `user` (string)
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string)
+            + scheduled_at: `2016-02-04T16:00:00+00:00` (string)
+            + status: `open` (enum[string])
+                + Members
+                    + `open`
+                    + `completed`
+            + custom_fields (array[CustomField])
+
+### calls.add [POST /calls.add]
+
+Add a new call.
+
++ Request (application/json)
+
+    + Attributes
+        + description: `Description of the call` (string, optional)
+        + participant (object, required)
+            + customer (object, required)
+                + type (enum, required)
+                    + Members
+                        + company
+                        + contact
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)
+        + due_at: `2016-02-04T16:00:00+00:00` (string, required)
+        + assignee (object, required)
+            + type (enum, required)
+                + Members
+                    + user
+            + id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+        + custom_fields (array[CustomFieldValue], optional)
+
++ Response 201 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + type: `call` (string)
+            + id: `65a35860-dcca-4850-9fd6-47ff08469e0c` (string)
+
+### calls.update [POST /calls.update]
+
+Update a new call.
+
++ Request (application/json)
+
+    + Attributes
+        + id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, required)
+        + description: `Description of the call` (string, optional)
+        + participant (object, optional)
+            + customer (object, optional)
+                + type (enum, required)
+                    + Members
+                        + company
+                        + contact
+                + id: `2659dc4d-444b-4ced-b51c-b87591f604d7` (string, required)
+        + due_at: `2016-02-04T16:00:00+00:00` (string, optional)
+        + assignee (object, optional)
+            + type (enum, required)
+                + Members
+                    + user
+            + id: `98b2863e-7b01-4232-82f5-ede1f0b9db22` (string, required)
+        + custom_fields (array[CustomFieldValue], optional)
+
++ Response 204 (application/json)
+
+### calls.complete [POST /calls.complete]
+
+Mark a call as complete.
+
++ Request (application/json)
+
+    + Attributes (object)
+        + id: `6fac0bf0-e803-424e-af67-76863a3d7d16` (string, required)
+        + call_outcome_id: `2b43633b-22d1-41b6-b87b-e1fd742325d4` (string, optional)
+        + outcome_summary: `Called, but was not available` (string, optional)
+
++ Response 204 (application/json)

src/04-calendar/meetings.apib

@@ -165,4 +165,4 @@ Get information about a meeting.
             + status (enum)
                 + Members
                     + open
-                    + done
+                    + done