Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meetings #739

Merged
merged 32 commits into from
Nov 23, 2023
Merged

Meetings #739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
2512e65
Document meetings.complete
Sep 26, 2023
392d545
Add change to changelog
Sep 26, 2023
bb65621
Merge branch 'master' into ATL-2280-meeting-complete
joaoinacio Oct 17, 2023
5ea8063
Document meetings.delete
Oct 18, 2023
ba837a7
document meetings.update
joaoinacio Oct 23, 2023
3f95b79
add to changelog
joaoinacio Oct 23, 2023
5c35a01
chore| add meeting.schedule
tiagobastos Oct 23, 2023
287d67e
chore| fix bad indentation on assignees
tiagobastos Oct 23, 2023
166e0e9
fix: use correct attendees property name
joaoinacio Oct 25, 2023
afdf7f2
add the location request parameter to meetings.update
joaoinacio Oct 25, 2023
375c79a
id is required for location type contact/company
joaoinacio Oct 25, 2023
13b3e93
Merge pull request #744 from teamleadercrm/ATL-2262-meetings_update
joaoinacio Oct 26, 2023
d5468f1
Merge remote-tracking branch 'origin/ATL-2280-meeting-complete' into …
tiagobastos Oct 26, 2023
bc89b7c
chore| fix attendees property & order they are displayed (for consist…
tiagobastos Oct 26, 2023
12294d8
chore| add location
tiagobastos Oct 26, 2023
e9b91db
fix| use correct wording
tiagobastos Oct 26, 2023
f7585f4
fix| /meetings.info location address
tiagobastos Oct 26, 2023
ad6a1bf
Merge pull request #746 from teamleadercrm/meetings.info
joaoinacio Oct 30, 2023
390ca9d
Merge pull request #745 from teamleadercrm/meetings.schedule
joaoinacio Oct 30, 2023
b7e9b1d
Merge remote-tracking branch 'origin/master' into ATL-2280-meeting-co…
tiagobastos Oct 30, 2023
0064877
fix| return meeting id on schedule
tiagobastos Nov 2, 2023
3f3d0df
chore| add finishing touches on meetings.* endpoints
tiagobastos Nov 3, 2023
da3a292
Document meeting web hooks
Nov 13, 2023
17ec30e
Provide meeting recurrence id
joaoinacio Nov 20, 2023
7777c61
Rename meeting.added to meeting.created
Nov 20, 2023
c471bba
Merge pull request #754 from teamleadercrm/ATL-2259-meetings-webhooks
Nov 20, 2023
3d15196
Merge branch 'ATL-2280-meeting-complete' into ATL-1251_meeting_recurr…
Nov 20, 2023
71a3373
Merge pull request #757 from teamleadercrm/ATL-1251_meeting_recurrence
tiagobastos Nov 20, 2023
c9a8102
Document recurrence_id filter on meetings.list
joaoinacio Nov 22, 2023
24bb806
Merge pull request #759 from teamleadercrm/ATL-2321_meetings_list_rec…
tiagobastos Nov 22, 2023
0f1b4ac
Merge remote-tracking branch 'origin/master' into ATL-2280-meeting-co…
tiagobastos Nov 22, 2023
6ba2f43
chore| move changes to current month
tiagobastos Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 188 additions & 11 deletions apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -3234,7 +3239,9 @@ Get a list of meetings.
+ Members
+ open
+ done

+ recurrence (object, nullable)
+ type: `recurrence` (string)
Copy link
Member

@mrtus mrtus Nov 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: We don't expose this resource anywhere yet, do we?

To which type refers this id then? Without exposing the resource I think we shouldn't include this property yet.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: We don't expose this resource anywhere yet, do we?

To which type refers this id then? Without exposing the resource I think we shouldn't include this property yet.

🤔 Right. the goal is to be able to list recurring meetings from a recurrence id, so providing the recurrence (definition) isn't necessary for now.
We can omit the type property for now and provide just the id, which is the necessary info to have.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, where would that id then come from? From existing meetings which return the recurrence?

Though, I wouldn't really remove the type if we'd still expose the id.

+ id: `1dfccc8e-68d0-0b83-8d1b-5cf1b0d99ab1` (string)

### meetings.info [POST /meetings.info]

Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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]

Expand Down Expand Up @@ -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
Expand Down
Loading