From 03d9ec5b8d822817917769a1838edb67fc23067a Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Tue, 4 Jun 2024 16:49:50 +0200 Subject: [PATCH 01/19] Add /daysOff.import documentation --- src/01-general/days-off.apib | 16 ++++++++++++++++ src/apiary.apib | 2 ++ src/changes-backwards-compatible.apib | 1 + 3 files changed, 19 insertions(+) create mode 100644 src/01-general/days-off.apib diff --git a/src/01-general/days-off.apib b/src/01-general/days-off.apib new file mode 100644 index 00000000..b90daefb --- /dev/null +++ b/src/01-general/days-off.apib @@ -0,0 +1,16 @@ +## 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) diff --git a/src/apiary.apib b/src/apiary.apib index 1600dacc..952aa573 100644 --- a/src/apiary.apib +++ b/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) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index c514cc14..fa88a416 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -6,6 +6,7 @@ We list all backwards-compatible additions here. These are currently available i #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. +- We added the `daysOff.import` endpoint. #### April 2024 - The meeting property `project` returned in `meetings.list` and `meetings.info` can now be an id of a `nextgenProject` as well. From cec2e7194fb43b45b781a7599df390d428f49410 Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Tue, 4 Jun 2024 16:50:05 +0200 Subject: [PATCH 02/19] Rebuild documentation --- apiary.apib | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/apiary.apib b/apiary.apib index 66812467..2255e0fe 100644 --- a/apiary.apib +++ b/apiary.apib @@ -428,6 +428,7 @@ We list all backwards-compatible additions here. These are currently available i #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. +- We added the `daysOff.import` endpoint. #### April 2024 - The meeting property `project` returned in `meetings.list` and `meetings.info` can now be an id of a `nextgenProject` as well. @@ -1818,6 +1819,23 @@ Returns a list of day off types for the account + `name`: `Sick leave` (string) +## 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) + # Group CRM ## Contacts [/contacts] From bfd2017512fa96186081c30ea24218830f28cb33 Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 6 Jun 2024 10:47:04 +0200 Subject: [PATCH 03/19] Move to June 2024 --- src/changes-backwards-compatible.apib | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 5158d70b..1930b545 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -4,10 +4,12 @@ We list all backwards-compatible additions here. These are currently available in all published versions. (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).) +#### June 2024 +- We added the `daysOff.import` endpoint. + #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. - We added `product.updated` and `product.deleted` to supported Webhook types. -- We added the `daysOff.import` endpoint. #### April 2024 - The meeting property `project` returned in `meetings.list` and `meetings.info` can now be an id of a `nextgenProject` as well. From 061486f83fbd6617e648740007b7d378903bb7b7 Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 6 Jun 2024 10:47:26 +0200 Subject: [PATCH 04/19] Rebuild documentation --- apiary.apib | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 221da978..548a6528 100644 --- a/apiary.apib +++ b/apiary.apib @@ -426,10 +426,12 @@ We consider the following changes to be backwards-incompatible: We list all backwards-compatible additions here. These are currently available in all published versions. (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).) +#### June 2024 +- We added the `daysOff.import` endpoint. + #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. - We added `product.updated` and `product.deleted` to supported Webhook types. -- We added the `daysOff.import` endpoint. #### April 2024 - The meeting property `project` returned in `meetings.list` and `meetings.info` can now be an id of a `nextgenProject` as well. @@ -1830,7 +1832,7 @@ Imports a list of days off for the given user. + 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 + + `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) From a2cc159c424d64d81602316cf5563c23a48c7b4d Mon Sep 17 00:00:00 2001 From: Gehad Moeiza Date: Fri, 7 Jun 2024 00:54:21 +0200 Subject: [PATCH 05/19] CON-288 Delete dayOffType API doc --- apiary.apib | 12 ++++++++++++ src/01-general/day-off-types.apib | 9 +++++++++ src/changes-backwards-compatible.apib | 3 +++ 3 files changed, 24 insertions(+) diff --git a/apiary.apib b/apiary.apib index 67c27191..ce04609c 100644 --- a/apiary.apib +++ b/apiary.apib @@ -426,6 +426,9 @@ We consider the following changes to be backwards-incompatible: We list all backwards-compatible additions here. These are currently available in all published versions. (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).) +#### June 2024 +- We added the `/dayOffTypes.delete` endpoint. + #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. - We added `product.updated` and `product.deleted` to supported Webhook types. @@ -1818,6 +1821,15 @@ Returns a list of day off types for the account + `id`: `39263c14-9c16-022d-8513-60cf722ab088` (string) + `name`: `Sick leave` (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 # Group CRM diff --git a/src/01-general/day-off-types.apib b/src/01-general/day-off-types.apib index 052b5b0c..7494e2e9 100644 --- a/src/01-general/day-off-types.apib +++ b/src/01-general/day-off-types.apib @@ -13,3 +13,12 @@ Returns a list of day off types for the account + `id`: `39263c14-9c16-022d-8513-60cf722ab088` (string) + `name`: `Sick leave` (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 diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 7c008c0a..496f7d54 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -4,6 +4,9 @@ We list all backwards-compatible additions here. These are currently available in all published versions. (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).) +#### June 2024 +- We added the `/dayOffTypes.delete` endpoint. + #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. - We added `product.updated` and `product.deleted` to supported Webhook types. From 83b3effe8189e69cb6693be3b634d83b081b6e89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Fri, 7 Jun 2024 13:34:36 +0100 Subject: [PATCH 06/19] Document daysOff.bulkDelete endpoint --- apiary.apib | 14 +++++++++++++- src/01-general/days-off.apib | 12 ++++++++++++ src/changes-backwards-compatible.apib | 2 +- 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 548a6528..97526d50 100644 --- a/apiary.apib +++ b/apiary.apib @@ -427,7 +427,7 @@ 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).) #### June 2024 -- We added the `daysOff.import` endpoint. +- We added the `daysOff.import` and `daysOff.bulkDelete` endpoints. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. @@ -1839,6 +1839,18 @@ Imports a list of days off for the given user. + 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 ## Contacts [/contacts] diff --git a/src/01-general/days-off.apib b/src/01-general/days-off.apib index b90daefb..268c3737 100644 --- a/src/01-general/days-off.apib +++ b/src/01-general/days-off.apib @@ -14,3 +14,15 @@ Imports a list of days off for the given user. + `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) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 1930b545..24252e68 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -5,7 +5,7 @@ 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).) #### June 2024 -- We added the `daysOff.import` endpoint. +- We added the `daysOff.import` and `daysOff.bulkDelete` endpoints. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From 2e70ff7e5ff13f43cb484435fb11e4a9b90348af Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Tue, 11 Jun 2024 18:16:35 +0200 Subject: [PATCH 07/19] Document the /closingDays.add endpoint --- src/01-general/closing-days.apib | 12 +++++++++++- src/changes-backwards-compatible.apib | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/src/01-general/closing-days.apib b/src/01-general/closing-days.apib index d1605562..d7224537 100644 --- a/src/01-general/closing-days.apib +++ b/src/01-general/closing-days.apib @@ -1,8 +1,18 @@ ## 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) + ### 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) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index d39fd7c7..a37d0075 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -7,6 +7,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 `daysOff.import` endpoint. +- We added the `closingDays.add` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From b04d1cd32c5a4368c390d8953ffe62a9ce60bebe Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Tue, 11 Jun 2024 18:16:44 +0200 Subject: [PATCH 08/19] Rebuild documentation --- apiary.apib | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/apiary.apib b/apiary.apib index 32b4dadb..df3d4992 100644 --- a/apiary.apib +++ b/apiary.apib @@ -429,6 +429,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 `daysOff.import` endpoint. +- We added the `closingDays.add` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. @@ -1785,9 +1786,19 @@ 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) + ### 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) From 5dda66368e11acf790b7699b7702a89e3bbaea2e Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Wed, 12 Jun 2024 17:04:02 +0200 Subject: [PATCH 09/19] Return the created id in the response --- src/01-general/closing-days.apib | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/01-general/closing-days.apib b/src/01-general/closing-days.apib index d7224537..9e2ea858 100644 --- a/src/01-general/closing-days.apib +++ b/src/01-general/closing-days.apib @@ -9,6 +9,10 @@ Adds a closing day for the account. + `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] From d1163ec51f873b98d2472ceac1d97d946331b646 Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Wed, 12 Jun 2024 17:04:30 +0200 Subject: [PATCH 10/19] Rebuild documentation --- apiary.apib | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/apiary.apib b/apiary.apib index df3d4992..a54a14b4 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1795,6 +1795,10 @@ Adds a closing day for the account. + `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] From a69f7ef21406e010808417b216c2737ddd644159 Mon Sep 17 00:00:00 2001 From: Gehad Moeiza Date: Fri, 14 Jun 2024 14:41:23 +0200 Subject: [PATCH 11/19] CON-207 document create day off type endpoint --- apiary.apib | 14 ++++++++++++++ src/01-general/day-off-types.apib | 13 +++++++++++++ src/changes-backwards-compatible.apib | 1 + 3 files changed, 28 insertions(+) diff --git a/apiary.apib b/apiary.apib index c4a095cd..4a43d019 100644 --- a/apiary.apib +++ b/apiary.apib @@ -428,6 +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. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. @@ -1821,6 +1822,19 @@ Returns a list of day off types for the account + `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, optional) + + from: `2024-04-04` (string, optional) + + unit: `2025-05-05` (string, optional) + ++ Response 204 (application/json) # Group CRM diff --git a/src/01-general/day-off-types.apib b/src/01-general/day-off-types.apib index 052b5b0c..8685f51f 100644 --- a/src/01-general/day-off-types.apib +++ b/src/01-general/day-off-types.apib @@ -13,3 +13,16 @@ Returns a list of day off types for the account + `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, optional) + + from: `2024-04-04` (string, optional) + + unit: `2025-05-05` (string, optional) + ++ Response 204 (application/json) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 609bdf8e..934fe278 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -6,6 +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. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From 7a4b7ff146b40964086dd42c7c81456c2575cd4f Mon Sep 17 00:00:00 2001 From: Gehad Moeiza Date: Mon, 17 Jun 2024 13:00:18 +0200 Subject: [PATCH 12/19] CON-307 update dayOffTypes.create response code and body --- apiary.apib | 9 ++++++++- src/01-general/day-off-types.apib | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 4a43d019..bf6782c7 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1834,7 +1834,14 @@ Create a new day off type. + from: `2024-04-04` (string, optional) + unit: `2025-05-05` (string, optional) -+ Response 204 (application/json) + ++ Response 201 (application/json) + + + Attributes (object) + + data (object) + + type: `dayOffType` (string) + + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string) + # Group CRM diff --git a/src/01-general/day-off-types.apib b/src/01-general/day-off-types.apib index 8685f51f..b7171205 100644 --- a/src/01-general/day-off-types.apib +++ b/src/01-general/day-off-types.apib @@ -25,4 +25,11 @@ Create a new day off type. + from: `2024-04-04` (string, optional) + unit: `2025-05-05` (string, optional) -+ Response 204 (application/json) + ++ Response 201 (application/json) + + + Attributes (object) + + data (object) + + type: `dayOffType` (string) + + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string) + From 55c0596f2c6aba16581cf8b00830984c53eb3a2e Mon Sep 17 00:00:00 2001 From: Gehad Moeiza Date: Mon, 17 Jun 2024 15:50:31 +0200 Subject: [PATCH 13/19] CON-307 remove slash --- apiary.apib | 2 +- src/changes-backwards-compatible.apib | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index bf6782c7..f6d65b65 100644 --- a/apiary.apib +++ b/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 `dayOffTypes.create` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 934fe278..de37c9eb 100644 --- a/src/changes-backwards-compatible.apib +++ b/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 `dayOffTypes.create` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From 29fd1027699e3be8700c0793081c53c27380f7f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Wed, 19 Jun 2024 10:28:08 +0100 Subject: [PATCH 14/19] document closingDays.delete endpoint --- apiary.apib | 11 +++++++++++ src/01-general/closing-days.apib | 10 ++++++++++ src/changes-backwards-compatible.apib | 1 + 3 files changed, 22 insertions(+) diff --git a/apiary.apib b/apiary.apib index a54a14b4..7f4a2084 100644 --- a/apiary.apib +++ b/apiary.apib @@ -430,6 +430,7 @@ We list all backwards-compatible additions here. These are currently available i - We added `tax` to the `products.info` endpoint. - We added the `daysOff.import` endpoint. - We added the `closingDays.add` endpoint. +- We added the `closingDays.delete` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. @@ -1800,6 +1801,16 @@ Adds a closing day for the account. + 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 + ### closingDays.list [POST /closingDays.list] Returns information about closing days of the account diff --git a/src/01-general/closing-days.apib b/src/01-general/closing-days.apib index 9e2ea858..f76866f0 100644 --- a/src/01-general/closing-days.apib +++ b/src/01-general/closing-days.apib @@ -14,6 +14,16 @@ Adds a closing day for the account. + 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 + ### closingDays.list [POST /closingDays.list] Returns information about closing days of the account diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index a37d0075..dc6067ac 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -8,6 +8,7 @@ We list all backwards-compatible additions here. These are currently available i - We added `tax` to the `products.info` endpoint. - We added the `daysOff.import` endpoint. - We added the `closingDays.add` endpoint. +- We added the `closingDays.delete` endpoint. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From 8a9b93e62e652ca958b93ce0a6f24d47d57ba40a Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 20 Jun 2024 11:36:27 +0200 Subject: [PATCH 15/19] Change order of endpoints to match day-off-types endpoints --- src/01-general/closing-days.apib | 43 ++++++++++++++++---------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/src/01-general/closing-days.apib b/src/01-general/closing-days.apib index f76866f0..7fb73bbc 100644 --- a/src/01-general/closing-days.apib +++ b/src/01-general/closing-days.apib @@ -1,5 +1,26 @@ ## 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. @@ -23,25 +44,3 @@ Removes a closing day for the account. + id: `eb264fd0-0e5c-0dbf-ae1e-49e7d6a8e6b8` (string, required) + Response 204 - -### 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) - From 291995d82648dd9ae2a4723cabf7b52f4554f6af Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 20 Jun 2024 11:37:45 +0200 Subject: [PATCH 16/19] Split into multiple lines by resource --- src/changes-backwards-compatible.apib | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 53cca147..85066bb4 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -6,7 +6,9 @@ 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 `daysOff.import`, `daysOff.bulkDelete`, `dayOffTypes.create`, `dayOffTypes.delete`, `closingDays.add` and `closingDays.delete` endpoints. +- We added the `daysOff.import` and `daysOff.bulkDelete` endpoints. +- We added the `dayOffTypes.create` and `dayOffTypes.delete` endpoints. +- We added the `closingDays.add` and `closingDays.delete` endpoints. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. From ba125bbeec08e816ce0a324d23b1d096784b49fc Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 20 Jun 2024 11:38:05 +0200 Subject: [PATCH 17/19] Rebuild documentation --- apiary.apib | 47 ++++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/apiary.apib b/apiary.apib index f92fb9e1..8c8393ab 100644 --- a/apiary.apib +++ b/apiary.apib @@ -428,7 +428,9 @@ 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 `daysOff.import`, `daysOff.bulkDelete`, `dayOffTypes.create`, `dayOffTypes.delete`, `closingDays.add` and `closingDays.delete` endpoints. +- We added the `daysOff.import` and `daysOff.bulkDelete` endpoints. +- We added the `dayOffTypes.create` and `dayOffTypes.delete` endpoints. +- We added the `closingDays.add` and `closingDays.delete` endpoints. #### May 2024 - We added `purchase_order_number` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update`. @@ -1785,6 +1787,27 @@ Create a new email tracking. ## 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. @@ -1809,28 +1832,6 @@ Removes a closing day for the account. + Response 204 -### 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) - - ## Day Off Types [/dayOffTypes] ### dayOffTypes.list [POST /dayOffTypes.list] From 46a3b4539c841e11a4ed0be83116d15be34d4645 Mon Sep 17 00:00:00 2001 From: Stephen Beirlaen Date: Thu, 20 Jun 2024 11:39:08 +0200 Subject: [PATCH 18/19] Remove duplicate line break --- apiary.apib | 1 - src/01-general/days-off.apib | 1 - 2 files changed, 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 8c8393ab..aecfdf05 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1893,7 +1893,6 @@ Imports a list of days off for the given user. + Response 201 (application/json) - ### daysOff.bulkDelete [POST /daysOff.bulkDelete] Deletes a list of days off for the given user. diff --git a/src/01-general/days-off.apib b/src/01-general/days-off.apib index 268c3737..1d0dbf50 100644 --- a/src/01-general/days-off.apib +++ b/src/01-general/days-off.apib @@ -15,7 +15,6 @@ Imports a list of days off for the given user. + Response 201 (application/json) - ### daysOff.bulkDelete [POST /daysOff.bulkDelete] Deletes a list of days off for the given user. From c2fd6b84f8f6f159494105b79a5bc0b7b7bb162f Mon Sep 17 00:00:00 2001 From: Gehad Moeiza Date: Fri, 21 Jun 2024 13:20:48 +0200 Subject: [PATCH 19/19] CON-3 adjust request doc for dayOffTypes.create --- apiary.apib | 6 +++--- src/01-general/day-off-types.apib | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apiary.apib b/apiary.apib index aecfdf05..0c858a4a 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1855,9 +1855,9 @@ Create a new day off type. + Attributes (object) + name: `day off type` (string, required) + color: `#00B2B2` (string, nullable, optional) - + date_validity (object, optional) - + from: `2024-04-04` (string, optional) - + unit: `2025-05-05` (string, optional) + + date_validity (object, nullable, optional) + + from: `2024-04-04` (string, required) + + unit: `2025-05-05` (string, required) + Response 201 (application/json) diff --git a/src/01-general/day-off-types.apib b/src/01-general/day-off-types.apib index 340b0d16..d6e8cf06 100644 --- a/src/01-general/day-off-types.apib +++ b/src/01-general/day-off-types.apib @@ -21,9 +21,9 @@ Create a new day off type. + Attributes (object) + name: `day off type` (string, required) + color: `#00B2B2` (string, nullable, optional) - + date_validity (object, optional) - + from: `2024-04-04` (string, optional) - + unit: `2025-05-05` (string, optional) + + date_validity (object, nullable, optional) + + from: `2024-04-04` (string, required) + + unit: `2025-05-05` (string, required) + Response 201 (application/json)