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

Some meta notes on the new endpoint issues #97

Open
maelle opened this issue Jan 20, 2020 · 0 comments
Open

Some meta notes on the new endpoint issues #97

maelle opened this issue Jan 20, 2020 · 0 comments

Comments

@maelle
Copy link
Contributor

maelle commented Jan 20, 2020

  • I used a script to create the issues to which @stephlocke has access.
  • use_r() and use_test() come from usethis. Both usethis and devtools are loaded by my .Rprofile, I recommend taking some time going through the usethis setup article.
  • Read the contributing guide
  • Any feedback on that guide, this issue, the endpoints issues is welcome. My instructions are not perfect at all and it'd be good to improve them.
  • There's a sort of exemplary PR add contacts list endpoint #83. Looking through scripts of other functions (not the deprecated ones) is also useful.
  • To define what useful tidiers could be, discuss with @stephlocke + think of what you'd like to work with in a report using Hubspot data.
  • There's no priority order for the open issues. I'd suggest to start with one you're familiar with as a Hubspot user, and if none is known to you, then with one that has only a few parameters.
  • Ignore the "o_auth_access_token_or_api_key" argument since there are a token and an apikey argument.
  • Also ignore the "offset" parameter, that we deal with internally.
  • The automatic names of functions are not necessarily very good. The pattern hs_<endpointname in snake case>_raw() is compulsory but e.g. prepositions should be dropped from the endpoint name.
  • I think there can only be one details section per Rd so when documenting view do that below the existing @details section of the R script template.
  • For endpoints that have arguments related to properties and property history (e.g. tickets), refer to what's been done in contacts.R in particular.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant