Feature/document types

[samamorgan]

Note: This is a breaking change. I have bumped the minor version to indicate that this is not backwards-compatible. Notably the separation of Formation classes and renaming a few inappropriately-named classes breaks compatibility with previous versions.

• Fixes #74
• Sets up refactor work for #18
  • Adds Target class to separate endpoints between different parts of Welkin
  • Adds Formation class as first use-case
• Moves all formation calls to appropriate classes
• Renames Documents to DocumentSummaries
• Renames Disposition to EncounterDisposition
• Moves Client.__build_resources to util._build_resources
• Moves client resources to class attributes, maintaining type hints for implementers
• Fixes FormationIterator and Client.request to appropriately parse formation data
• Fixes some minor formatting issues
• Removes unnecessary parentheses on vcr markers
• Forces vcrpy to decode compressed JSON responses
• Adds tests for all new formation classes
• Replaces all HTTP status integers with http.HTTPStatus enum values for clarity

[gone]

It looks good to me - I think you should do it as a major version vs minor since semver generally says breaking changes are major releases.

I also think, from looking at all the formation classes, you might want to implement them with something like a standardized get call and a self.url format string that gets used, since that would shave off like 30/40 lines of boilerplate

[samamorgan]

It looks good to me - I think you should do it as a major version vs minor since semver generally says breaking changes are major releases.

I'm specifically not doing this because to me a major version indicates that the product is out of beta. This library is not yet feature-complete, does not implement all documented Welkin endpoints. From semver docs:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable. ... Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

I also think, from looking at all the formation classes, you might want to implement them with something like a standardized get call and a self.url format string that gets used, since that would shave off like 30/40 lines of boilerplate

I'll give this a shot. I've been avoiding that in general since it does in some ways reduce extensibility, but for these it may be appropriate.