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

New release needed ? Or doc update ? #55

Closed
flohw opened this issue Aug 22, 2024 · 2 comments
Closed

New release needed ? Or doc update ? #55

flohw opened this issue Aug 22, 2024 · 2 comments

Comments

@flohw
Copy link

flohw commented Aug 22, 2024

Hi,

I use the library in my project to ask for signatures. As the documentation states after a task start request, we get the remaining credits only.

I just tested but got a "something went wrong on our side". The response contains "remaining_files" but no trace of "remaining_credits" nor "remaining_pages" as Task class references.

Are the credits converted to remaining files properly?

Does it require a library new release with the two new properties (Task::$remainingPages and Task::$remainingCredits) or the documentation needs an update ? Is the Task::$remainingFiles deprecated? It could be nice to add @deprecated in this case and mention it on the documentation.

I am a bit worried that the API may change without notice by removing data from response and break in production. Can you provide some information about your upgrade process?

Thank you

@maztch
Copy link
Collaborator

maztch commented Dec 5, 2024

When user do a start step, api knows the credits cost for the concrete tool, this means it will return remaining pages or remaining files. If you ask to info endpoint, api dones not knows about cost, so response will have remaining credits.
This means for many tools (all previous existing tools), the start will return the same remaining files as before because only new tools are using pages.

@maztch maztch closed this as completed Dec 5, 2024
@maztch
Copy link
Collaborator

maztch commented Dec 5, 2024

New iloveapi website with updated documentation is also in process, with currently hidden properties and more endpoints...

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