Naming Conventions and Deprecation Policy about hubspot3

[jpetrucciani]

First off I'd like to thank you and your colleagues for the contributions on behalf of everyone using this library! Looking forward to more PR's coming in! 😄

Yep, a few of these clients are particularly gross name-wise at the moment. I'm still thinking about which naming convention I like the best, but I'm open to suggestions as well!

I think at the moment, I prefer the more explicit names (perhaps like update_by_email and update_by_id), and deprecating the regular update method (and also the ones ending in the a_contact because I agree that it's not great that way!). It's also a bit odd here because in a few other clients, you can only lookup by ID, and so we just use the basic get delete and update method names like in the CompaniesClient:

hubspot3/hubspot3/companies.py

Lines 34 to 47 in 6791c78

	def update(self, company_id: str, data: Dict = None, **options) -> Dict:
	"""update the given company with data"""
	data = data or {}
	return self._call(
	"companies/{}".format(company_id), data=data, method="PUT", **options
	)
	def delete(self, company_id: str, **options) -> Dict:
	"""delete a company"""
	return self._call("companies/{}".format(company_id), method="DELETE", **options)
	def get(self, company_id: str, **options) -> Dict:
	"""get a single company by it's ID"""
	return self._call("companies/{}".format(company_id), method="GET", **options)

I think that inside ContactsClient they should be renamed from update_a_contact and delete_a_contact to update_by_id and delete_by_id respectively (and deprecating the former) to make a bit more sense, since we're already in the context of Contacts, so having the word contact in the method name seems a bit redundant! And also doing the same to get_contact_by_email and get_contact_by_id -> get_by_email and get_by_id may make more sense in the long run.

[W1ldPo1nter]

Thanks for the quick reply!

We are also preferring concise names without redundancy, so we'll make these changes the way you proposed. A PR will come your way as soon as we got this done (including the new endpoints).

[W1ldPo1nter]

I'm closing this since these questions were specific to the Contacts API and the corresponding changes are already pulled. Thanks for the quick answers and pulls.

[jpetrucciani]

Also to the point of deprecation notice, we could just say next major version bump, or just sometime in the future! I do know it may be annoying to have something small like that break, but it'd be a pretty quick fix whenever someone upgrades the library - we'd just want to make sure that we have it documented in the release notes!