Merge branch 'master' into renovate/actions-checkout-4.x

Author: tiagobastos

apiary.apib

@@ -0,0 +1,46 @@
+## Closing Days [/closingDays]
+
+### closingDays.list [POST /closingDays.list]
+
+Returns information about closing days of the account
+
++ Request (application/json)
+    + Attributes (object)
+        + filter (object, optional)
+            + date_before: `2023-12-31` (string, optional) - Start of the period for which to return closing days. This includes closing days starting on the date provided.
+            + date_after: `2023-12-01` (string, optional) - End of the period for which to return closing days. This includes closing days ending on the date provided.
+        + page (Page, optional)
+
++ Response 200 (application/json)
+    + Attributes (object)
+        + `data` (array)
+            + (object)
+                + `id`: `05676ac4-c61d-42bf-a3ea-a420fc1ec017` (string)
+                + `date`: `2023-12-21` (string)
+        + meta (object) - Only included with request parameter `includes=pagination`
+            + page (Pagination)
+            + matches: `12` (number)
+
+### closingDays.add [POST /closingDays.add]
+
+Adds a closing day for the account.
+
++ Request (application/json)
+    + Attributes (object)
+        + `day`: `2024-02-01` (string, required)
+
++ Response 201 (application/json)
+    + Attributes (object)
+        + data (object)
+            + type: `closingDay` (string)
+            + id: `eb264fd0-0e5c-0dbf-ae1e-49e7d6a8e6b8` (string, required)
+
+### closingDays.delete [POST /closingDays.delete]
+
+Removes a closing day for the account.
+
++ Request (application/json)
+    + Attributes (object)
+        + id: `eb264fd0-0e5c-0dbf-ae1e-49e7d6a8e6b8` (string, required)
+
++ Response 204

src/01-general/closing-days.apib

@@ -9,6 +9,19 @@ Get a list of all the definitions of custom fields.
 + Request (application/json)
 
     + Attributes (object)
+        + filter (object, optional)
+            + ids: `9c64570b-4ec1-4e03-9662-af904f78f7fa`,`aa6d2560-63f9-4b2f-bf96-823dc7c34df7` (array[string], optional)
+            + context (enum, optional) - Filters on context
+                + Members
+                    + contact
+                    + company
+                    + deal
+                    + project
+                    + milestone
+                    + product
+                    + invoice
+                    + subscription
+                    + ticket
         + page (Page, optional)
         + sort (array, optional)
             + (object)

src/01-general/custom-fields.apib

@@ -0,0 +1,58 @@
+## Day Off Types [/dayOffTypes]
+
+### dayOffTypes.list [POST /dayOffTypes.list]
+
+Returns a list of day off types for the account
+
++ Request (application/json)
+
++ Response 200 (application/json)
+    + Attributes (object)
+        + `data` (array)
+            + (object)
+                + `id`: `39263c14-9c16-022d-8513-60cf722ab088` (string)
+                + `name`: `Sick leave` (string)
+
+### dayOffTypes.create [POST /dayOffTypes.create]
+
+Create a new day off type.
+
++ Request (application/json)
+    + Attributes (object)
+        + name: `day off type` (string, required)
+        + color: `#00B2B2` (string, nullable, optional)
+        + date_validity (object, nullable, optional)
+            + from: `2024-04-04` (string, required)
+            + unit: `2025-05-05` (string, required)
+
+
++ Response 201 (application/json)
+    + Attributes (object)
+        + data (object)
+            + type: `dayOffType` (string)
+            + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string)
+
+### dayOffTypes.update [POST /dayOffTypes.update]
+
+Update a day off type.
+
++ Request (application/json)
+    + Attributes (object)
+        + `id`: `1b7cece0-288c-0bbe-b916-5a315fbe9fe2` (string, required)
+        + name: `day off type` (string, optional)
+        + color: `#00B2B2` (string, optional)
+        + date_validity (object, nullable, optional)
+            + from: `2024-04-04` (string, required)
+            + unit: `2025-05-05` (string, required)
+
++ Response 204 (application/json)
+
+### dayOffTypes.delete [POST /dayOffTypes.delete]
+
+Delete a day off type.
+
++ Request (application/json)
+    + Attributes (object)
+        + `id`: `1b7cece0-288c-0bbe-b916-5a315fbe9fe2` (string, required)
+
++ Response 204

src/01-general/day-off-types.apib

@@ -0,0 +1,27 @@
+## Days Off [/daysOff]
+
+### daysOff.import [POST /daysOff.import]
+
+Imports a list of days off for the given user.
+
++ Request (application/json)
+    + Attributes (object)
+        + `user_id`: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) - The id of the user that the days off belong to.
+        + `leave_type_id`: `0f517e20-2e76-4684-8d6c-3334f6d7148c` (string, required) - The id of the leave type that is associated with the given days off.
+        + `days` (array, required) - At least one day must be present
+            + (object)
+                + `starts_at`: `2024-02-01T08:00:00+00:00` (string, required)
+                + `ends_at`: `2024-02-01T18:00:00+00:00` (string, required)
+
++ Response 201 (application/json)
+
+### daysOff.bulkDelete [POST /daysOff.bulkDelete]
+
+Deletes a list of days off for the given user.
+
++ Request (application/json)
+    + Attributes (object)
+        + `user_id`: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) - The id of the user that the days off belong to.
+        + `ids`: `0a481ce9-0d2a-0913-9439-0fd8b469b566`, `5050789e-4385-02f6-bd3c-d051cc12f5cf`  (array[string]) - At least one day off id must be present.
+
++ Response 204 (application/json)

src/01-general/days-off.apib

@@ -0,0 +1,46 @@
+## Email Tracking [/emailTracking]
+
+### emailTracking.list [POST /emailTracking.list]
+
+Get a list of all email tracking.
+
++ Request (application/json;charset=utf-8)
+
+    + Attributes (object)
+        + filter (object, required)
+            + subject (object, required)
+                + type: `contact` (EmailTrackingSubjectTypes, required)
+                + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string, required)
+        + page (Page, optional)
+
++ Response 200 (application/json;charset=utf-8)
+
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `a344c251-2494-0013-b433-ccee8e8435e5` (string)
+                + title: `an email subject` (string)
+                + content: `<p>the contents of the received email</p>` (string)
+                + subject (object)
+                    + type: `contact` (EmailTrackingSubjectTypes)
+                    + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string)
+                + added_at: `2016-01-01T00:00:00+00:00` (string)
+
+### emailTracking.create [POST /emailTracking.create]
+
+Create a new email tracking.
+
++ Request (application/json)
+    + Attributes (object)
+        + subject (object, required)
+            + type: `contact` (EmailTrackingSubjectTypes, required)
+            + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string, required)
+        + title: `an email subject` (string, optional)
+        + content: `<p>the contents of the received email</p>` (string, required)
+
++ Response 201 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + type: `emailTracking` (string)
+            + id: `91e99ae3-16f9-01d7-9046-9a501cb2155f` (string)

src/01-general/email-tracking.apib

@@ -0,0 +1,61 @@
+## Notes [/notes]
+
+### notes.list [POST /notes.list]
+
+Get a list of all notes.
+
++ Request (application/json;charset=utf-8)
+
+    + Attributes (object)
+        + filter (object, required)
+            + subject (object, required)
+                + type: `contact` (NoteSubjectTypes, required)
+                + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string, required)
+        + page (Page, optional)
+
++ Response 200 (application/json;charset=utf-8)
+
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + id: `a344c251-2494-0013-b433-ccee8e8435e5` (string)
+                + content: `new note content` (string)
+                + subject (object)
+                    + type: `contact` (NoteSubjectTypes)
+                    + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string)
+                + added_at: `2016-01-01T00:00:00+00:00` (string)
+
+### notes.create [POST /notes.create]
+
+Create a new note.
+
++ Request (application/json)
+    + Attributes (object)
+        + subject (object, required)
+            + type: `contact` (NoteSubjectTypes, required)
+            + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string, required)
+        + content: `new note content` (string, required)
+        + notify (array, optional)
+            + (object)
+                + type: `user` (enum, required)
+                    + Members
+                        + `user`
+                + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required)
+
++ Response 201 (application/json)
+
+    + Attributes (object)
+        + data (object)
+            + type: `note` (string)
+            + id: `ee94b4c0-5786-0517-9d26-8dd1e6406f20` (string)
+
+### notes.update [POST /notes.update]
+
+Update an existing note.
+
++ Request (application/json)
+    + Attributes (object)
+        + id: `36386b05-936e-4cc0-9523-bd20d797ebf5` (string, required)
+        + content: `new note content` (string, optional)
+
++ Response 204

src/01-general/notes.apib

@@ -19,6 +19,10 @@ Get the current authenticated user.
             + first_name: `John` (string)
             + last_name: `Smith` (string)
             + email: `[email protected]` (string)
+            + email_verification_status: `confirmed` (enum)
+                + Members
+                    + pending
+                    + confirmed
             + telephones (array[Telephone])
             + language: `nl-BE` (enum)
                 + Members
@@ -102,6 +106,11 @@ Get a list of all users.
                     + Members
                         + active
                         + deactivated
+                + teams (array)
+                    + (object)
+                        + type: `team` (string)
+                        + id: `6dd0069e-45da-0ec4-911a-afb351d968cd`
+
 
 ### users.info [POST /users.info]
 
@@ -111,6 +120,7 @@ Get details for a single user.
 
     + Attributes (object)
         + id: `cb8da52a-ce89-4bf6-8f7e-8ee6cb85e3b5` (string, required)
+        + includes: `external_rate` (string, optional) - when used, the response will include `external_rate`
 
 + Response 200 (application/json)
 
@@ -146,3 +156,47 @@ Get details for a single user.
                 + Members
                     + active
                     + deactivated
+            + teams (array)
+                + (object)
+                    + type: `team` (string)
+                    + id: `6dd0069e-45da-0ec4-911a-afb351d968cd`
+            + `external_rate` (Money, nullable) - Only included with request parameter `includes=external_rate`
+
+
+### users.listDaysOff [POST /users.listDaysOff]
+
+Returns information about days off of a given user.
+
++ Request (application/json)
+    + Attributes (object)
+        + id: `87982c96-f2fe-4b05-838c-ff42c0525758` (string, required)
+        + filter (object, optional)
+            + `starts_after`: `2023-10-01` (string, optional) - Start of the period for which to return days off.
+            + `ends_before`: `2023-10-30` (string, optional) - End of the period for which to return days off.
+        + page (Page, optional)
+
++ Response 200 (application/json)
+    + Attributes (object)
+        + data (array)
+            + (object)
+                + `id`: `f611da79-90c2-02b1-b819-a810e0c77291` (string)
+                + `starts_at`: `2023-10-01T09:00:00+01:00` (string)
+                + `ends_at`: `2023-10-20T18:00:00+01:00` (string)
+                + user (object)
+                    + `type`: `user` (enum[string])
+                        + Members
+                            + `user`
+                    + `id`: `b5094b3f-bb7a-0391-b01b-e709773f3509` (string)
+                + leave_type (object)
+                    + `type`: `dayOffType` (enum[string])
+                        + Members
+                            + `dayOffType`
+                    + `id`: `f68b123c-4c36-0f5c-ac16-11f498e5dc01` (string)
+                + `status`: `approved` (enum)
+                    + Members
+                        + `approved`
+                        + `not_approved`
+                        + `pending`
+        + meta (object) - Only included with request parameter `includes=pagination`
+            + page (Pagination)
+            + matches: `12` (number)

src/01-general/users.apib

@@ -92,6 +92,7 @@ Get details for a single company.
 
     + Attributes (object)
         + id: `e8d31ae7-8258-4fcd-9b2d-78f41b0aa5d5` (string, required)
+        + includes: `related_companies,related_contacts` (string, optional) - when used, the response will include `related_companies` and/or `related_contacts`
 
 + Response 200 (application/json)
 
@@ -143,6 +144,18 @@ Get details for a single company.
             + tags: prospect, expo (array[string])
             + custom_fields (array[CustomField])
             + marketing_mails_consent: false (boolean)
+            + `related_companies` (array) - Only included with request parameter `includes=related_companies`
+                + (object)
+                    + type: `company` (string)
+                    + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+            + `related_contacts` (array) - Only included with request parameter `includes=related_contacts`
+                + (object)
+                    + type: `contact` (string)
+                    + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+                    + position: `Developer` (string, nullable)
+                    + secondary_position: `Technical lead` (string, nullable)
+                    + division: `Engineering` (string, nullable)
+                    + is_decision_maker: false (boolean)
 
 ### companies.add [POST /companies.add]