DEVEXP-269 (Part 1/2): Refactor Voice models #24
Conversation
| import { VoicePrice } from '../voice-price'; | ||
| import { Participant } from '../participant'; | ||
|
|
||
| export interface CallObject { |
There was a problem hiding this comment.
It took me some time to identify what mean "CallObject" and it usage.
Finally have to ensure I was right by looking at the OAS file details to identify it is the getCallResponseObj schema.
So finally, may be it could mean the name should convey more information for auto-documentation purpose and readability for maintainers
There was a problem hiding this comment.
Naming is a complicated task :)
The main object here is a 'Call' which is also the name of the service 'Calls' and also the verb 'call'. This is why I've added the suffix 'Object' to be clear about which kind of call it was and to avoid a naming conflict.
Then, the operationId is Calling_GetCallResult but here "Result" doesn't mean "Response" but rather "Status" which confused me too. The response object defined in the specification is getCallResponseObj which is "the object that represents the response of a getCall (status) query". So I thought to name it "CallResponse" but then it would be confusing with the actions of the "Call" service.
Long story short: what do you think about CallInformation?
There was a problem hiding this comment.
Yes; and it is not so far from documentation related to operation: Get information about a call
There was a problem hiding this comment.
Fixed. In the end it's GetCallInformation as it is the result of a GET call, such as "get callbacks" for instance
…tructions (#25) * DEVEXP-269: Add helpers for building SVAML actions and instructions * Add 'call' function for conference API * Add AMD * Add transcription locale
This PR is mainly about some refactoring among generated models. Nothing major here.
Only notable change:
voice.applications.getNumbersbecomesvoice.applications.listNumbersto stay consistent with our naming => To be updated in other SDKs