fix sdk

Author: emnbdx

.github/workflows/python.yml

@@ -3,7 +3,7 @@
 #
 # ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: helloasso-python Python package
+name: helloasso_python Python package
 
 on: [push, pull_request]
 
@@ -28,4 +28,4 @@ jobs:
           pip install -r test-requirements.txt
       - name: Test with pytest
         run: |
-          pytest --cov=helloasso-python
+          pytest --cov=helloasso_python

.gitlab-ci.yml

@@ -12,7 +12,7 @@ stages:
   script:
    - pip install -r requirements.txt
    - pip install -r test-requirements.txt
-   - pytest --cov=helloasso-python
+   - pytest --cov=helloasso_python
 
 pytest-3.8:
   extends: .pytest

.openapi-generator-ignore

@@ -21,3 +21,5 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+
+README.md

.openapi-generator/FILES

@@ -14,4 +14,4 @@ install:
   - "pip install -r requirements.txt"
   - "pip install -r test-requirements.txt"
 # command to run tests
-script: pytest --cov=helloasso-python
+script: pytest --cov=helloasso_python

.travis.yml

@@ -1,12 +1,6 @@
 # helloasso-python
-HelloAsso auto-generated SDK
 
-This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: public
-- Package version: 1.0.0
-- Generator version: 7.12.0
-- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+The HelloAsso Python library offers a straightforward way to interact with the HelloAsso API in Python applications. It features a collection of pre-built classes for API resources that automatically adapt to API responses, ensuring flexibility across different versions of the HelloAsso API.
 
 ## Requirements.
 
@@ -18,13 +12,13 @@ Python 3.8+
 If the python package is hosted on a repository, you can install directly using:
 
 ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+pip install helloasso-python
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+(you may need to run `pip` with root permission: `sudo pip install helloasso-python`)
 
 Then import the package:
 ```python
-import helloasso-python
+import helloasso_python
 ```
 
 ### Setuptools
@@ -38,7 +32,7 @@ python setup.py install --user
 
 Then import the package:
 ```python
-import helloasso-python
+import helloasso_python
 ```
 
 ### Tests
@@ -51,13 +45,13 @@ Please follow the [installation procedure](#installation--usage) and then run th
 
 ```python
 
-import helloasso-python
-from helloasso-python.rest import ApiException
+import helloasso_python
+from helloasso_python.rest import ApiException
 from pprint import pprint
 
 # Defining the host is optional and defaults to https://api.helloasso.com/v5
 # See configuration.py for a list of all supported configuration parameters.
-configuration = helloasso-python.Configuration(
+configuration = helloasso_python.Configuration(
     host = "https://api.helloasso.com/v5"
 )
 
@@ -70,12 +64,12 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 
 # Enter a context with an instance of the API client
-with helloasso-python.ApiClient(configuration) as api_client:
+with helloasso_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = helloasso-python.AnnuaireApi(api_client)
+    api_instance = helloasso_python.AnnuaireApi(api_client)
     page_size = 20 # int | The number of items per page (optional) (default to 20)
     continuation_token = 'continuation_token_example' # str | Continuation Token from which we wish to retrieve results (optional)
-    hello_asso_api_v5_models_directory_list_forms_request = helloasso-python.HelloAssoApiV5ModelsDirectoryListFormsRequest() # HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply (optional)
+    hello_asso_api_v5_models_directory_list_forms_request = helloasso_python.HelloAssoApiV5ModelsDirectoryListFormsRequest() # HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply (optional)
 
     try:
         # Récupérer les formulaires
@@ -238,22 +232,116 @@ Class | Method | HTTP request | Description
  - [ResultsWithPaginationModelSynchronizableOrganizationModel](docs/ResultsWithPaginationModelSynchronizableOrganizationModel.md)
 
 
-<a id="documentation-for-authorization"></a>
-## Documentation For Authorization
+## Authorization
 
+We use OAuth2 for authentication, so to avoid reinventing the wheel, we recommend using the [Authlib](https://pypi.org/project/Authlib) package
 
-Authentication schemes defined for the API:
-<a id="OAuth2"></a>
-### OAuth2
+### Prerequisite
+Install the Authlib package:
 
-- **Type**: OAuth
-- **Flow**: application
-- **Authorization URL**: 
-- **Scopes**: N/A
+```bash
+pip install requests
+pip install Authlib
+```
 
+### Client Credentials Flow
+```python
+from authlib.integrations.requests_client import OAuth2Session
+
+# Configuration
+client_id = 'your_client_id'
+client_secret = 'your_client_secret'
+token_url = 'https://api.helloasso.com/oauth2/token'
+
+# Create an OAuth2 session
+client = OAuth2Session(client_id, client_secret)
+
+# Get an access token
+def get_access_token():
+    token = client.fetch_token(token_url, grant_type='client_credentials')
+    print("Access Token:", token['access_token'])
+    print("Expires In:", token['expires_in'])
+    print("Refresh Token:", token['refresh_token'])
+    return token
+
+# Usage
+get_access_token()
+```
 
-## Author
+### Refresh Token Flow
+```python
+from authlib.integrations.requests_client import OAuth2Session
+
+# Configuration
+client_id = 'your_client_id'
+client_secret = 'your_client_secret'
+token_url = 'https://api.helloasso.com/oauth2/token'
+
+# Refresh the token
+def refresh_access_token(refresh_token):
+    client = OAuth2Session(client_id, client_secret)
+    token = client.refresh_token(token_url, refresh_token=refresh_token)
+    print("New Access Token:", token['access_token'])
+    print("Expires In:", token['expires_in'])
+    print("New Refresh Token:", token['refresh_token'])
+    return token
+
+# Usage
+refresh_access_token('your_refresh_token')
+```
 
+### Authorization Code Flow
+```python
+import base64
+import hashlib
+import os
+from authlib.integrations.requests_client import OAuth2Session
+
+# Configuration
+client_id = 'your_client_id'
+client_secret = 'your_client_secret'
+authorize_url = 'https://auth.helloasso.com/authorize'
+token_url = 'https://api.helloasso.com/oauth2/token'
+redirect_uri = 'https://your-app.com/callback'
+
+# PKCE Helper Functions
+def generate_code_verifier():
+    """Generate a high-entropy code_verifier."""
+    return base64.urlsafe_b64encode(os.urandom(32)).rstrip(b'=').decode('utf-8')
+
+def generate_code_challenge(code_verifier):
+    """Generate a code_challenge based on the code_verifier."""
+    code_challenge = hashlib.sha256(code_verifier.encode('utf-8')).digest()
+    return base64.urlsafe_b64encode(code_challenge).rstrip(b'=').decode('utf-8')
+
+# Step 1: Generate the Authorization URL
+def get_authorization_url():
+    # Generate PKCE parameters
+    code_verifier = generate_code_verifier()
+    code_challenge = generate_code_challenge(code_verifier)
+
+    client = OAuth2Session(client_id, client_secret, redirect_uri=redirect_uri)
+    authorization_url, state = client.create_authorization_url(authorize_url, code_challenge=code_challenge, code_challenge_method='S256')
+    print("Authorization URL: ", authorization_url)
+    print("Code verifier: ", code_verifier)
+
+# Step 2: Exchange the authorization code for an access token
+def get_access_token_from_code(authorization_response, code_verifier):
+    client = OAuth2Session(client_id, client_secret, redirect_uri=redirect_uri)
+    token = client.fetch_token(token_url, authorization_response=authorization_response, code_verifier=code_verifier)
+    print("Access Token: ", token['access_token'])
+    print("Expires In: ", token['expires_in'])
+    print("Refresh Token: ", token['refresh_token'])
+
+# Usage
+get_authorization_url()
+# After user authorizes, exchange the code (passed in the redirect URL callback)
+#get_access_token_from_code('your_authorization_code', 'your_code_verifier')
+```
 
+## About this package
 
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen

README.md

@@ -1,4 +1,4 @@
-# helloasso-python.AnnuaireApi
+# helloasso_python.AnnuaireApi
 
 All URIs are relative to *https://api.helloasso.com/v5*
 
@@ -20,15 +20,15 @@ Permet de récupérer une liste de tous les formulaires visibles correspondant 
 * OAuth Authentication (OAuth2):
 
 ```python
-import helloasso-python
-from helloasso-python.models.hello_asso_api_v5_models_directory_list_forms_request import HelloAssoApiV5ModelsDirectoryListFormsRequest
-from helloasso-python.models.results_with_pagination_model_synchronizable_form_model import ResultsWithPaginationModelSynchronizableFormModel
-from helloasso-python.rest import ApiException
+import helloasso_python
+from helloasso_python.models.hello_asso_api_v5_models_directory_list_forms_request import HelloAssoApiV5ModelsDirectoryListFormsRequest
+from helloasso_python.models.results_with_pagination_model_synchronizable_form_model import ResultsWithPaginationModelSynchronizableFormModel
+from helloasso_python.rest import ApiException
 from pprint import pprint
 
 # Defining the host is optional and defaults to https://api.helloasso.com/v5
 # See configuration.py for a list of all supported configuration parameters.
-configuration = helloasso-python.Configuration(
+configuration = helloasso_python.Configuration(
     host = "https://api.helloasso.com/v5"
 )
 
@@ -40,12 +40,12 @@ configuration = helloasso-python.Configuration(
 configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 # Enter a context with an instance of the API client
-with helloasso-python.ApiClient(configuration) as api_client:
+with helloasso_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = helloasso-python.AnnuaireApi(api_client)
+    api_instance = helloasso_python.AnnuaireApi(api_client)
     page_size = 20 # int | The number of items per page (optional) (default to 20)
     continuation_token = 'continuation_token_example' # str | Continuation Token from which we wish to retrieve results (optional)
-    hello_asso_api_v5_models_directory_list_forms_request = helloasso-python.HelloAssoApiV5ModelsDirectoryListFormsRequest() # HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply (optional)
+    hello_asso_api_v5_models_directory_list_forms_request = helloasso_python.HelloAssoApiV5ModelsDirectoryListFormsRequest() # HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply (optional)
 
     try:
         # Récupérer les formulaires
@@ -102,15 +102,15 @@ Permet de récupérer une liste de toutes les organisations visibles corresponda
 * OAuth Authentication (OAuth2):
 
 ```python
-import helloasso-python
-from helloasso-python.models.hello_asso_api_v5_models_directory_list_organizations_request import HelloAssoApiV5ModelsDirectoryListOrganizationsRequest
-from helloasso-python.models.results_with_pagination_model_synchronizable_organization_model import ResultsWithPaginationModelSynchronizableOrganizationModel
-from helloasso-python.rest import ApiException
+import helloasso_python
+from helloasso_python.models.hello_asso_api_v5_models_directory_list_organizations_request import HelloAssoApiV5ModelsDirectoryListOrganizationsRequest
+from helloasso_python.models.results_with_pagination_model_synchronizable_organization_model import ResultsWithPaginationModelSynchronizableOrganizationModel
+from helloasso_python.rest import ApiException
 from pprint import pprint
 
 # Defining the host is optional and defaults to https://api.helloasso.com/v5
 # See configuration.py for a list of all supported configuration parameters.
-configuration = helloasso-python.Configuration(
+configuration = helloasso_python.Configuration(
     host = "https://api.helloasso.com/v5"
 )
 
@@ -122,12 +122,12 @@ configuration = helloasso-python.Configuration(
 configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 # Enter a context with an instance of the API client
-with helloasso-python.ApiClient(configuration) as api_client:
+with helloasso_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = helloasso-python.AnnuaireApi(api_client)
+    api_instance = helloasso_python.AnnuaireApi(api_client)
     page_size = 20 # int | The number of items per page (optional) (default to 20)
     continuation_token = 'continuation_token_example' # str | Continuation Token from which we wish to retrieve results (optional)
-    hello_asso_api_v5_models_directory_list_organizations_request = helloasso-python.HelloAssoApiV5ModelsDirectoryListOrganizationsRequest() # HelloAssoApiV5ModelsDirectoryListOrganizationsRequest | Body which contains the filters to apply (optional)
+    hello_asso_api_v5_models_directory_list_organizations_request = helloasso_python.HelloAssoApiV5ModelsDirectoryListOrganizationsRequest() # HelloAssoApiV5ModelsDirectoryListOrganizationsRequest | Body which contains the filters to apply (optional)
 
     try:
         # Récupérer les organisations

docs/AnnuaireApi.md

@@ -1,4 +1,4 @@
-# helloasso-python.CheckoutApi
+# helloasso_python.CheckoutApi
 
 All URIs are relative to *https://api.helloasso.com/v5*
 
@@ -20,14 +20,14 @@ Retourne aussi la commande associée. Uniquement dans le cas ou le paiement est
 * OAuth Authentication (OAuth2):
 
 ```python
-import helloasso-python
-from helloasso-python.models.hello_asso_api_v5_models_carts_checkout_intent_response import HelloAssoApiV5ModelsCartsCheckoutIntentResponse
-from helloasso-python.rest import ApiException
+import helloasso_python
+from helloasso_python.models.hello_asso_api_v5_models_carts_checkout_intent_response import HelloAssoApiV5ModelsCartsCheckoutIntentResponse
+from helloasso_python.rest import ApiException
 from pprint import pprint
 
 # Defining the host is optional and defaults to https://api.helloasso.com/v5
 # See configuration.py for a list of all supported configuration parameters.
-configuration = helloasso-python.Configuration(
+configuration = helloasso_python.Configuration(
     host = "https://api.helloasso.com/v5"
 )
 
@@ -39,9 +39,9 @@ configuration = helloasso-python.Configuration(
 configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 # Enter a context with an instance of the API client
-with helloasso-python.ApiClient(configuration) as api_client:
+with helloasso_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = helloasso-python.CheckoutApi(api_client)
+    api_instance = helloasso_python.CheckoutApi(api_client)
     organization_slug = 'organization_slug_example' # str | 
     checkout_intent_id = 56 # int | 
     with_failed_refund_operation = False # bool |  (optional) (default to False)
@@ -101,15 +101,15 @@ Pour tout savoir sur Checkout consultez d'abord notre <a href="https://dev.hello
 * OAuth Authentication (OAuth2):
 
 ```python
-import helloasso-python
-from helloasso-python.models.hello_asso_api_v5_models_carts_init_checkout_body import HelloAssoApiV5ModelsCartsInitCheckoutBody
-from helloasso-python.models.hello_asso_api_v5_models_carts_init_checkout_response import HelloAssoApiV5ModelsCartsInitCheckoutResponse
-from helloasso-python.rest import ApiException
+import helloasso_python
+from helloasso_python.models.hello_asso_api_v5_models_carts_init_checkout_body import HelloAssoApiV5ModelsCartsInitCheckoutBody
+from helloasso_python.models.hello_asso_api_v5_models_carts_init_checkout_response import HelloAssoApiV5ModelsCartsInitCheckoutResponse
+from helloasso_python.rest import ApiException
 from pprint import pprint
 
 # Defining the host is optional and defaults to https://api.helloasso.com/v5
 # See configuration.py for a list of all supported configuration parameters.
-configuration = helloasso-python.Configuration(
+configuration = helloasso_python.Configuration(
     host = "https://api.helloasso.com/v5"
 )
 
@@ -121,11 +121,11 @@ configuration = helloasso-python.Configuration(
 configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 # Enter a context with an instance of the API client
-with helloasso-python.ApiClient(configuration) as api_client:
+with helloasso_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = helloasso-python.CheckoutApi(api_client)
+    api_instance = helloasso_python.CheckoutApi(api_client)
     organization_slug = 'organization_slug_example' # str | 
-    hello_asso_api_v5_models_carts_init_checkout_body = helloasso-python.HelloAssoApiV5ModelsCartsInitCheckoutBody() # HelloAssoApiV5ModelsCartsInitCheckoutBody |  (optional)
+    hello_asso_api_v5_models_carts_init_checkout_body = helloasso_python.HelloAssoApiV5ModelsCartsInitCheckoutBody() # HelloAssoApiV5ModelsCartsInitCheckoutBody |  (optional)
 
     try:
         # Initialisation d'un Checkout