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

Documentation / Default Behavior Complaint => Default QboApi.minor_version = false #131

Open
roboyeti opened this issue Mar 8, 2024 · 1 comment

Comments

@roboyeti
Copy link

roboyeti commented Mar 8, 2024

Problem:

  • The docs state: This client does not run against the latest QBO API minor version by default. To run all requests with a specific minor version, you must specify it: QboApi.minor_version = #
  • Minor version of QBO api is now at 70.
  • I spent hours trying to get include=invoiceLink to work on invoice query. Adding miner_version = 70 fixed it (sort of, the sandbox company generates a bad URL, but it can be fixed by inspecting the payment URL generated in company manager UI and subbing in the correct url path and has nothing to do with this Gem).

While technically, this does fix it, not being compatible with a much more recent QBO minor version makes the QB API docs substantially worthless and confusing to users of this Gem when the API docs don't actually do what they expect from this api interface.

Not having your Gem API match the latest documentation makes this Gem frustrating, which is presumably the opposite of desired results.

I have not crawled thru the code to see if there is a way to change the default behavior and just use the latest minor version, so with that fact, my current suggestions are:

Solutions:
1.> fixed to operate automatically, or with a boolean, to use the latest minor version without specifying a specific version, and then use minor_version to lock someone in to an older version (code change)
Or
2.> The documentation should explicitly state that they probably SHOULD change the minor version, so it matches at all with the online docs API ... AND ... maybe it is time to add a default minor_version (as a side note, changing minor_version from a boolean to an integer is a little strange IMHO).

The advantage of #1 is that the online documentation and this api gem will not grow out of sync with every advancing day.

Presumably, Intuit isn't so obnoxious as to add breaking changes to the API on minor versions ... but I don't know, this is my first experience with their API ... which hasn't been very happy, lol.

This would also be more consistent with gem use, where you typically want to automatically use the latest sub versions of a gem, but can lock in a specific one if bugs appear.

If someone is still active enough around here to merge changes, I can certainly make the doc change or make the code change (presuming there is a way to get minor version list from from QB API ...?).

@minimul
Copy link
Owner

minimul commented Mar 11, 2024

Let's go with your second suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants