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.

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

`/calls.{info,list} | Use completed as the terminology #758

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -3332,7 +3332,7 @@ Get a list of calls.
+ relates_to (object, optional) - Filter calls by related object (currently only companies allowed)
+ id: `415fa7e0-e319-0952-b973-f067f2b49d56` (string)
+ type: `company` (string)
+ call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on done calls by outcome
+ call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on completed calls by outcome
+ page (object, optional)
+ size: `20` (number, optional) - The amount of entries returned per request, max 1 to 100
+ Default: `20`
Expand Down Expand Up @@ -3365,7 +3365,7 @@ Get a list of calls.
+ status: `open` (enum[string])
+ Members
+ `open`
+ `done`
+ `completed`
+ meta (object) - Only included with request parameter `includes=pagination`
+ page (Pagination)
+ matches: `12` (number)
Expand Down Expand Up @@ -3405,7 +3405,7 @@ Get information about a call.
+ status: `open` (enum[string])
+ Members
+ `open`
+ `done`
+ `completed`
+ custom_fields (array[CustomField])

### calls.add [POST /calls.add]
Expand Down
6 changes: 3 additions & 3 deletions src/04-calendar/calls.apib
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Get a list of calls.
+ relates_to (object, optional) - Filter calls by related object (currently only companies allowed)
+ id: `415fa7e0-e319-0952-b973-f067f2b49d56` (string)
+ type: `company` (string)
+ call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on done calls by outcome
+ call_outcome_id: `6bd20dd8-dc3f-0e68-8919-dee0be6efe55` (string, optional) - Filter on completed calls by outcome
+ page (object, optional)
+ size: `20` (number, optional) - The amount of entries returned per request, max 1 to 100
+ Default: `20`
Expand Down Expand Up @@ -45,7 +45,7 @@ Get a list of calls.
+ status: `open` (enum[string])
+ Members
+ `open`
+ `done`
+ `completed`
+ meta (object) - Only included with request parameter `includes=pagination`
+ page (Pagination)
+ matches: `12` (number)
Expand Down Expand Up @@ -85,7 +85,7 @@ Get information about a call.
+ status: `open` (enum[string])
+ Members
+ `open`
+ `done`
+ `completed`
+ custom_fields (array[CustomField])

### calls.add [POST /calls.add]
Expand Down