diff --git a/apiary.apib b/apiary.apib index 14dc9750..e0334c30 100644 --- a/apiary.apib +++ b/apiary.apib @@ -430,6 +430,10 @@ We list all backwards-compatible additions here. These are currently available i - 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 the `meetings.schedule`, `meetings.update`, `meetings.complete` and `meetings.delete` endpoints. +- We added `meeting.created`, `meeting.updated` and `meeting.deleted` types to supported Webhook types. +- The `meetings.info` and `meetings.list` endpoints now return the meeting recurrence id for recurring meetings. +- The `meetings.list` endpoint can now filter meetings by recurrence id. - We added `custom_fields` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update` #### October 2023 @@ -3168,6 +3172,7 @@ Get a list of meetings. + `end_date`: `2019-02-04` (string, optional) + `milestone_id`: `f29abf48-337d-44b4-aad4-585f5277a456` (string, optional) + `term`: `funny joke HR meeting` (string, optional) + + `recurrence_id`: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string, optional) + page (Page, optional) + sort (array, optional) + (object) @@ -3190,8 +3195,8 @@ Get a list of meetings. + data (array) + (object) + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) - + title (string) - + description (string) + + title: `My meeting` (string) + + description: `My meeting description` (string) + created_at: `2020-02-01T10:33:45+00:00` (string) + scheduled_at: `2020-02-04T16:44:33+00:00` (string) + duration (object) @@ -3234,7 +3239,9 @@ Get a list of meetings. + Members + open + done - + + recurrence (object, nullable) + + type: `recurrence` (string) + + id: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string) ### meetings.info [POST /meetings.info] @@ -3251,8 +3258,8 @@ Get information about a meeting. + Attributes (object) + data (object) + id: `70af3fdd-b037-0936-ad1a-6d784dd44cf4` (string) - + title (string) - + description (string) + + title: `My meeting` (string) + + description: `My meeting description` (string) + scheduled_at: `2020-02-04T16:44:33+00:00` (string) + duration (object) + unit (enum) @@ -3296,14 +3303,36 @@ Get information about a meeting. + contact + company + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) - + address (AddressResponse) - + Properties + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `address` (string) - + address (AddressResponse) - + Properties + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `customLocation` (string) - + address (AddressResponse) - + Properties + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string) + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `calendarResource` (string) + online_meeting_room (object, nullable) + type: `onlineMeetingRoom` (string) @@ -3320,6 +3349,151 @@ Get information about a meeting. + Members + open + done + + recurrence (object, nullable) + + type: `recurrence` (string) + + id: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string) + +### meetings.schedule [POST /meetings.schedule] + +Schedule a meeting. + ++ Request (application/json) + + + Attributes (object) + + title: `My meeting` (string, required) + + starts_at: `2023-10-01T09:00:00+01:00` (string, required) + + ends_at: `2023-10-01T10:00:00+01:00` (string, required) + + description: `My meeting description` (string, optional) + + attendees (array, required) - at least one user attendee must be present + + (object) + + `type`: `user` (enum[string]) + + Members + + `user` + + `contact` + + `id`: `66abace2-62af-0836-a927-fe3f44b9b47b` (string) + + customer (object, optional) + + type: `contact` (enum) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) + + location (object, optional) + + One Of + + Properties + + type: `virtual` (string, required) + + Properties + + type: `contact` (enum[string], required) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `address` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `customLocation` (string, required) + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string, required) + + milestone_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional) + + deal_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional) + + custom_fields (array[CustomFieldValue], optional) + ++ Response 201 (application/json) + + + Attributes (object) + + data (object) + + type: `meeting` (string) + + id: `00ed6266-a5bd-4aac-a292-2582017b6400` (string) + +### meetings.update [POST /meetings.update] + +Update a meeting. + ++ Request (application/json) + + + Attributes (object) + + id: `00ed6266-a5bd-4aac-a292-2582017b6400` (string, required) + + title: `My meeting` (string, optional) + + starts_at: `2023-10-01T09:00:00+01:00` (string, optional) + + ends_at: `2023-10-01T10:00:00+01:00` (string, optional) + + description: `My meeting description` (string, optional, nullable) + + attendees (array, optional) - when provided, at least one user attendee must be present + + (object) + + `type`: `user` (enum[string]) + + Members + + `user` + + `contact` + + `id`: `66abace2-62af-0836-a927-fe3f44b9b47b` (string) + + customer (object, optional, nullable) + + type: `contact` (enum) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) + + location (object, optional) + + One Of + + Properties + + type: `virtual` (string, required) + + Properties + + type: `contact` (enum[string], required) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `address` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `customLocation` (string, required) + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string, required) + + milestone_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional, nullable) + + deal_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional, nullable) + + custom_fields (array[CustomFieldValue], optional) + ++ Response 204 + +### meetings.complete [POST /meetings.complete] + +Mark a meeting as complete. + ++ Request (application/json) + + + Attributes (object) + + id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required) + ++ Response 204 + +### meetings.delete [POST /meetings.delete] + +Deletes a meeting. + ++ Request (application/json) + + + Attributes (object) + + id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required) + ++ Response 204 ## Calls [/calls] @@ -7969,6 +8143,9 @@ Fetch cloudPlatform url for type and id + invoice.paymentRemoved + invoice.sent + invoice.updated + + meeting.created + + meeting.updated + + meeting.deleted + milestone.created + milestone.updated + product.added diff --git a/src/04-calendar/meetings.apib b/src/04-calendar/meetings.apib index cb11c407..1f06add9 100644 --- a/src/04-calendar/meetings.apib +++ b/src/04-calendar/meetings.apib @@ -14,6 +14,7 @@ Get a list of meetings. + `end_date`: `2019-02-04` (string, optional) + `milestone_id`: `f29abf48-337d-44b4-aad4-585f5277a456` (string, optional) + `term`: `funny joke HR meeting` (string, optional) + + `recurrence_id`: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string, optional) + page (Page, optional) + sort (array, optional) + (object) @@ -36,8 +37,8 @@ Get a list of meetings. + data (array) + (object) + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) - + title (string) - + description (string) + + title: `My meeting` (string) + + description: `My meeting description` (string) + created_at: `2020-02-01T10:33:45+00:00` (string) + scheduled_at: `2020-02-04T16:44:33+00:00` (string) + duration (object) @@ -80,7 +81,9 @@ Get a list of meetings. + Members + open + done - + + recurrence (object, nullable) + + type: `recurrence` (string) + + id: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string) ### meetings.info [POST /meetings.info] @@ -97,8 +100,8 @@ Get information about a meeting. + Attributes (object) + data (object) + id: `70af3fdd-b037-0936-ad1a-6d784dd44cf4` (string) - + title (string) - + description (string) + + title: `My meeting` (string) + + description: `My meeting description` (string) + scheduled_at: `2020-02-04T16:44:33+00:00` (string) + duration (object) + unit (enum) @@ -142,14 +145,36 @@ Get information about a meeting. + contact + company + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) - + address (AddressResponse) - + Properties + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `address` (string) - + address (AddressResponse) - + Properties + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `customLocation` (string) - + address (AddressResponse) - + Properties + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string) + + address (object) + + line_1: `Dok Noord 3A 101` (string, nullable) + + postal_code: `9000` (string, nullable) + + city: `Ghent` (string, nullable) + + country: `BE` (string) + + area_level_two (object, nullable) + + type: `area_level_two` (string) + + id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` (string) + + Properties + type: `calendarResource` (string) + online_meeting_room (object, nullable) + type: `onlineMeetingRoom` (string) @@ -166,3 +191,148 @@ Get information about a meeting. + Members + open + done + + recurrence (object, nullable) + + type: `recurrence` (string) + + id: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string) + +### meetings.schedule [POST /meetings.schedule] + +Schedule a meeting. + ++ Request (application/json) + + + Attributes (object) + + title: `My meeting` (string, required) + + starts_at: `2023-10-01T09:00:00+01:00` (string, required) + + ends_at: `2023-10-01T10:00:00+01:00` (string, required) + + description: `My meeting description` (string, optional) + + attendees (array, required) - at least one user attendee must be present + + (object) + + `type`: `user` (enum[string]) + + Members + + `user` + + `contact` + + `id`: `66abace2-62af-0836-a927-fe3f44b9b47b` (string) + + customer (object, optional) + + type: `contact` (enum) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) + + location (object, optional) + + One Of + + Properties + + type: `virtual` (string, required) + + Properties + + type: `contact` (enum[string], required) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `address` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `customLocation` (string, required) + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string, required) + + milestone_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional) + + deal_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional) + + custom_fields (array[CustomFieldValue], optional) + ++ Response 201 (application/json) + + + Attributes (object) + + data (object) + + type: `meeting` (string) + + id: `00ed6266-a5bd-4aac-a292-2582017b6400` (string) + +### meetings.update [POST /meetings.update] + +Update a meeting. + ++ Request (application/json) + + + Attributes (object) + + id: `00ed6266-a5bd-4aac-a292-2582017b6400` (string, required) + + title: `My meeting` (string, optional) + + starts_at: `2023-10-01T09:00:00+01:00` (string, optional) + + ends_at: `2023-10-01T10:00:00+01:00` (string, optional) + + description: `My meeting description` (string, optional, nullable) + + attendees (array, optional) - when provided, at least one user attendee must be present + + (object) + + `type`: `user` (enum[string]) + + Members + + `user` + + `contact` + + `id`: `66abace2-62af-0836-a927-fe3f44b9b47b` (string) + + customer (object, optional, nullable) + + type: `contact` (enum) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string) + + location (object, optional) + + One Of + + Properties + + type: `virtual` (string, required) + + Properties + + type: `contact` (enum[string], required) + + Members + + contact + + company + + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `address` (string, required) + + `address` (object, required) + + line_1: `Dok Noord 3A 101` (string, required, nullable) + + postal_code: `9000` (string, required, nullable) + + city: `Ghent` (string, required, nullable) + + country: `BE` (string, required) + + area_level_two_id: `db232cf8-ad4a-024b-941f-15a7a74f0fd2` + + Properties + + type: `customLocation` (string, required) + + id: `4191c526-5e26-0818-8e16-9523215b5081` (string, required) + + milestone_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional, nullable) + + deal_id: `32665afd-1818-0ed3-9e18-a603a3a21b95` (string, optional, nullable) + + custom_fields (array[CustomFieldValue], optional) + ++ Response 204 + +### meetings.complete [POST /meetings.complete] + +Mark a meeting as complete. + ++ Request (application/json) + + + Attributes (object) + + id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required) + ++ Response 204 + +### meetings.delete [POST /meetings.delete] + +Deletes a meeting. + ++ Request (application/json) + + + Attributes (object) + + id: `46156648-87c6-478d-8aa7-1dc3a00dacab` (string, required) + ++ Response 204 diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 39012e20..3ac70de5 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -8,6 +8,10 @@ We list all backwards-compatible additions here. These are currently available i - 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 the `meetings.schedule`, `meetings.update`, `meetings.complete` and `meetings.delete` endpoints. +- We added `meeting.created`, `meeting.updated` and `meeting.deleted` types to supported Webhook types. +- The `meetings.info` and `meetings.list` endpoints now return the meeting recurrence id for recurring meetings. +- The `meetings.list` endpoint can now filter meetings by recurrence id. - We added `custom_fields` to `projects-v2/projects.info`, `projects-v2/projects.create` and `projects-v2/projects.update` #### October 2023 diff --git a/src/datastructures.apib b/src/datastructures.apib index 76af5744..1049f8c6 100644 --- a/src/datastructures.apib +++ b/src/datastructures.apib @@ -154,6 +154,9 @@ + invoice.paymentRemoved + invoice.sent + invoice.updated + + meeting.created + + meeting.updated + + meeting.deleted + milestone.created + milestone.updated + product.added