Merge branch 'feature/CON-3/days-off' into CON-307-Create-dayOffType-…

…API-doc

apiary.apib

@@ -428,7 +428,7 @@ We list all backwards-compatible additions here. These are currently available i
 
 #### June 2024
 - We added `tax` to the `products.info` endpoint.
-- We added the `dayOffTypes.create` endpoint.
+- We added the `daysOff.import`, `daysOff.bulkDelete`, `dayOffTypes.create`, `dayOffTypes.delete` and `closingDays.add` endpoints.
 
 #### May 2024
 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`.
@@ -1785,9 +1785,23 @@ Create a new email tracking.
 
 ## Closing Days [/closingDays]
 
+### 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.list [POST /closingDays.list]
 
-Returns information about closing days the account
+Returns information about closing days of the account
 
 + Request (application/json)
     + Attributes (object)
@@ -1836,12 +1850,49 @@ Create a new day off type.
 
 
 + Response 201 (application/json)
-
     + Attributes (object)
         + data (object)
             + type: `dayOffType` (string)
             + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string)
 
+### 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
+
+## 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)
 
 # Group CRM
 

src/01-general/closing-days.apib

@@ -1,8 +1,22 @@
 ## Closing Days [/closingDays]
 
+### 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.list [POST /closingDays.list]
 
-Returns information about closing days the account
+Returns information about closing days of the account
 
 + Request (application/json)
     + Attributes (object)

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

@@ -27,9 +27,17 @@ Create a new day off type.
 
 
 + Response 201 (application/json)
-
     + Attributes (object)
         + data (object)
             + type: `dayOffType` (string)
             + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string)
 
+### 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/days-off.apib

@@ -0,0 +1,28 @@
+## 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/apiary.apib

@@ -37,6 +37,8 @@ HOST: https://api.focus.teamleader.eu
 
 :[Day Off Types](./01-general/day-off-types.apib)
 
+:[Days Off](./01-general/days-off.apib)
+
 # Group CRM
 
 :[Contacts](./02-crm/contacts.apib)

src/changes-backwards-compatible.apib

@@ -6,7 +6,7 @@ We list all backwards-compatible additions here. These are currently available i
 
 #### June 2024
 - We added `tax` to the `products.info` endpoint.
-- We added the `dayOffTypes.create` endpoint.
+- We added the `daysOff.import`, `daysOff.bulkDelete`, `dayOffTypes.create`, `dayOffTypes.delete` and `closingDays.add` endpoints.
 
 #### May 2024
 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`.