Hrflow

* Migrate on Poetry
* Add Ask endpoint
* Add Auth endpoint
* Add Unfold endpoint
* Handle batch in tagging
* Fix typo in README.md
* Create a testsuite

- Added detailed Profile and Objects fields description in storing endpoints
- To be able to seamlessly index Profiles & Jobs from structured sources in HrFlow.ai

HRFlow API Version 3.1.0 Release Notes

Minor Version Update - Improved Profile and Job Updates

In the 3.1.0 version of the HRFlow API, we have made a minor enhancement to the update process for both Profiles and Jobs. Now, when updating a Profile or a Job, it is no longer mandatory to provide the key as a keyword argument. This change offers more flexibility and ease of use when updating objects.

**Key Features and Changes:**
- Profiles and Jobs can now be updated using either the key or reference as a keyword argument.
- The update process is now more flexible and allows for simpler object updates.
- This version is backward compatible, and the key is still accepted as a keyword argument.

For detailed information on how to use the updated update functionality, please refer to the latest version of the API documentation and examples.

> **We recommend all users to update to this latest version to take advantage of the improved object update process. Thank you for your continued support and feedback.**

For more information, detailed API documentation, and examples, please visit our [GitHub repository](https://github.com/hrflow/python-hrflow-api).

If you have any questions or need assistance, please reach out to us at [integrationshrflow.ai](mailto:integrationshrflow.ai).

🎉 New Features:

- Introduced new API Tracking: Allows you to track a Profile (or a Job) for Job (or a Profile) as a recruiter (or a candidate) with a specific action. For more details, refer to the [Tracking API Documentation](https://developers.hrflow.ai/reference/post-tracking).
- Introduced new API Rating: Enables you to rate a Profile (or a Job) for Job (or a Profile) as a recruiter (or a candidate) with a score between 0 and 1. For more information, visit the [Rating API Documentation](https://developers.hrflow.ai/reference/post-rating).

⚠️ Breaking Changes:

- The resource indexing in both profile and job has been renamed to storing. It still offers the same functionality (with the same methods) and has introduced a new list method. This method allows you to apply additional filters when querying objects in the HrFlow.ai data warehouses (Sources and Boards).

🤝 Getting Started Notebooks:

- Added notebooks with examples to provide hands-on usage of the SDK and demonstrate how to use each module of our suite for both profiles and jobs. You can find the notebooks in the `examples` folder at the root of the project.

> **We encourage all users to upgrade to this latest version to take advantage of the new features and improvements. For more information, please refer to the updated documentation and examples.
> Thank you for your continued support and feedback.**

For more information and detailed API documentation, visit our [GitHub repository](https://github.com/hrflow/python-hrflow-api).

If you have any questions or need assistance, please reach out to us at [integrationshrflow.ai](mailto:integrationshrflow.ai).

We are pleased to announce the release of HrFlow.ai Python sdk **v2.1.0**!

- This version fix the breaking change introduced in [v2.0.0](https://github.com/Riminder/python-hrflow-api/releases/tag/v2.0.1)
- The breaking change was the removal of the document API replaced by text.
- This version is a patch to avoid breaking changes in the API for any users that uses the document API for parsing text.
- ⚠️ This version will be deprecated in the future.

We are pleased to announce the release of HrFlow.ai Python sdk **v2.0.0**! This version includes major updates and features such as:

- Adding previously introduced APIs in developers to the SDK
- [Storing Profiles API](https://developers.hrflow.ai/reference/get-all-profiles) : This endpoint allows you to retrieve the list of profiles stored in Sources.
- [Storing Jobs API](https://developers.hrflow.ai/reference/get-all-jobs) : This endpoint allows you to retrieve the list of jobs stored in a Board.
- [Tagging API](https://developers.hrflow.ai/reference/tag-a-text) : This allows to predict most likely tags for a text with our library of AI algorithms.
- [OCR API](https://developers.hrflow.ai/reference/ocr-a-text) :This endpoint allows you to extract a the text from a document across all formats (pdf, docx, png, and more)
- [Imaging API](https://developers.hrflow.ai/reference/text-imaging) : This endpoint allows you to generate an image from a job description.
- **⚠️ Breaking Change** : Update deprecated document API classes by text ones
- General improvement on APIs documentation