Skip to content

Commit f856105

Browse files
actions-useractions-user
committed
Update python SDK from OpenAPI Generator
1 parent 6452a1a commit f856105

97 files changed

Lines changed: 1224 additions & 247 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ docs/HelloAssoApiV5CommonModelsFormsFormPublicModel.md
6868
docs/HelloAssoApiV5CommonModelsFormsFormQuickCreateModel.md
6969
docs/HelloAssoApiV5CommonModelsFormsFormQuickCreateRequest.md
7070
docs/HelloAssoApiV5CommonModelsFormsFormStateRequest.md
71+
docs/HelloAssoApiV5CommonModelsFormsFormStatsModel.md
7172
docs/HelloAssoApiV5CommonModelsFormsTermModel.md
7273
docs/HelloAssoApiV5CommonModelsFormsTierLightModel.md
7374
docs/HelloAssoApiV5CommonModelsFormsTierPublicModel.md
75+
docs/HelloAssoApiV5CommonModelsFormsTierStatsModel.md
7476
docs/HelloAssoApiV5CommonModelsOrganizationsOrganizationBasicModel.md
7577
docs/HelloAssoApiV5CommonModelsOrganizationsOrganizationLightModel.md
7678
docs/HelloAssoApiV5CommonModelsOrganizationsOrganizationPublicModel.md
@@ -195,9 +197,11 @@ helloasso_python/models/hello_asso_api_v5_common_models_forms_form_public_model.
195197
helloasso_python/models/hello_asso_api_v5_common_models_forms_form_quick_create_model.py
196198
helloasso_python/models/hello_asso_api_v5_common_models_forms_form_quick_create_request.py
197199
helloasso_python/models/hello_asso_api_v5_common_models_forms_form_state_request.py
200+
helloasso_python/models/hello_asso_api_v5_common_models_forms_form_stats_model.py
198201
helloasso_python/models/hello_asso_api_v5_common_models_forms_term_model.py
199202
helloasso_python/models/hello_asso_api_v5_common_models_forms_tier_light_model.py
200203
helloasso_python/models/hello_asso_api_v5_common_models_forms_tier_public_model.py
204+
helloasso_python/models/hello_asso_api_v5_common_models_forms_tier_stats_model.py
201205
helloasso_python/models/hello_asso_api_v5_common_models_organizations_organization_basic_model.py
202206
helloasso_python/models/hello_asso_api_v5_common_models_organizations_organization_light_model.py
203207
helloasso_python/models/hello_asso_api_v5_common_models_organizations_organization_public_model.py
@@ -239,4 +243,6 @@ setup.cfg
239243
setup.py
240244
test-requirements.txt
241245
test/__init__.py
246+
test/test_hello_asso_api_v5_common_models_forms_form_stats_model.py
247+
test/test_hello_asso_api_v5_common_models_forms_tier_stats_model.py
242248
tox.ini

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.20.0
1+
7.21.0

‎docs/FormsApi.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.helloasso.com/v5*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**organizations_organization_slug_forms_form_type_form_slug_state_put**](FormsApi.md#organizations_organization_slug_forms_form_type_form_slug_state_put) | **PUT** /organizations/{organizationSlug}/forms/{formType}/{formSlug}/state | Update a form state
8+
[**organizations_organization_slug_forms_form_type_form_slug_stats_get**](FormsApi.md#organizations_organization_slug_forms_form_type_form_slug_stats_get) | **GET** /organizations/{organizationSlug}/forms/{formType}/{formSlug}/stats | Get Stats for the form
89

910

1011
# **organizations_organization_slug_forms_form_type_form_slug_state_put**
@@ -82,3 +83,78 @@ No authorization required
8283

8384
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
8485

86+
# **organizations_organization_slug_forms_form_type_form_slug_stats_get**
87+
> HelloAssoApiV5CommonModelsFormsFormStatsModel organizations_organization_slug_forms_form_type_form_slug_stats_get(organization_slug, form_slug, form_type)
88+
89+
Get Stats for the form
90+
91+
<br/><br/><b>Your token must have one of these roles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>If you are an <b>association</b>, you can obtain these roles with your client.<br/>If you are a <b>partner</b>, you can obtain these roles by the authorize flow.<br/><br/><b>Your clientId must be allowed all of those privileges : </b> <br/> AccessPublicData<br/><br/>
92+
93+
### Example
94+
95+
96+
```python
97+
import helloasso_python
98+
from helloasso_python.models.hello_asso_api_v5_common_models_enums_form_type import HelloAssoApiV5CommonModelsEnumsFormType
99+
from helloasso_python.models.hello_asso_api_v5_common_models_forms_form_stats_model import HelloAssoApiV5CommonModelsFormsFormStatsModel
100+
from helloasso_python.rest import ApiException
101+
from pprint import pprint
102+
103+
# Defining the host is optional and defaults to https://api.helloasso.com/v5
104+
# See configuration.py for a list of all supported configuration parameters.
105+
configuration = helloasso_python.Configuration(
106+
host = "https://api.helloasso.com/v5"
107+
)
108+
109+
110+
# Enter a context with an instance of the API client
111+
with helloasso_python.ApiClient(configuration) as api_client:
112+
# Create an instance of the API class
113+
api_instance = helloasso_python.FormsApi(api_client)
114+
organization_slug = 'organization_slug_example' # str |
115+
form_slug = 'form_slug_example' # str |
116+
form_type = helloasso_python.HelloAssoApiV5CommonModelsEnumsFormType() # HelloAssoApiV5CommonModelsEnumsFormType |
117+
118+
try:
119+
# Get Stats for the form
120+
api_response = api_instance.organizations_organization_slug_forms_form_type_form_slug_stats_get(organization_slug, form_slug, form_type)
121+
print("The response of FormsApi->organizations_organization_slug_forms_form_type_form_slug_stats_get:\n")
122+
pprint(api_response)
123+
except Exception as e:
124+
print("Exception when calling FormsApi->organizations_organization_slug_forms_form_type_form_slug_stats_get: %s\n" % e)
125+
```
126+
127+
128+
129+
### Parameters
130+
131+
132+
Name | Type | Description | Notes
133+
------------- | ------------- | ------------- | -------------
134+
**organization_slug** | **str**| |
135+
**form_slug** | **str**| |
136+
**form_type** | [**HelloAssoApiV5CommonModelsEnumsFormType**](.md)| |
137+
138+
### Return type
139+
140+
[**HelloAssoApiV5CommonModelsFormsFormStatsModel**](HelloAssoApiV5CommonModelsFormsFormStatsModel.md)
141+
142+
### Authorization
143+
144+
No authorization required
145+
146+
### HTTP request headers
147+
148+
- **Content-Type**: Not defined
149+
- **Accept**: text/plain, application/json, text/json
150+
151+
### HTTP response details
152+
153+
| Status code | Description | Response headers |
154+
|-------------|-------------|------------------|
155+
**200** | Success | - |
156+
**401** | Unauthorized, you must add a valid JWT into Authorization Header with the format : &#x60;Bearer TOKEN&#x60; | - |
157+
**403** | The JWT token hasn&#39;t the privileges or Roles for this action | - |
158+
159+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
160+

‎docs/HelloAssoApiV5CommonModelsDirectoryDirectoryOrganizationPublicModel.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**tags** | **List[str]** | The public tags of the organization | [optional]
1010
**linked_partners** | **List[str]** | Partners linked to this organization | [optional]
1111
**is_authenticated** | **bool** | The organization is authenticated. Property returned only when asked by an organization admin. | [optional]
12+
**display_coordinates** | **bool** | If the organization chose to display its coordinates. Property returned only when asked by an organization admin. | [optional]
1213
**is_cash_in_compliant** | **bool** | If transaction can be init on the organization or not. Property returned only when asked by an organization admin. | [optional]
1314
**banner** | **str** | The organization banner | [optional]
1415
**fiscal_receipt_eligibility** | **bool** | The organism can issue fiscal receipts (type ok and has not deactivated it) Must configure it and be authenticated to become enabled | [optional]

‎docs/HelloAssoApiV5CommonModelsEnumsOrganizationType.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@
6565

6666
* `AUTRES` (value: `'Autres'`)
6767

68+
* `EPA` (value: `'EPA'`)
69+
6870
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
6971

7072

‎docs/HelloAssoApiV5CommonModelsFormsFormQuickCreateRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Name | Type | Description | Notes
4545
**allow_organism_payer** | **bool** | Whether users are allowed to contribute to this form through an organism (only for donation and crowdfunding). | [optional]
4646
**allow_individual_payer** | **bool** | Whether user are allowed to personally contribute to this form (only for donation and crowdfunding). | [optional]
4747
**remind_abandoned_cart** | **bool** | Whether a reminder email should be sent for abandoned carts. | [optional]
48+
**display_version** | **int** | The form display version (only for membership). | [optional]
4849
**max_entries** | **int** | Indicates the maximum available entries for the whole form. Null means unlimited entries. | [optional]
4950

5051
## Example

‎docs/HelloAssoApiV5CommonModelsFormsFormStatsModel.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# HelloAssoApiV5CommonModelsFormsFormStatsModel
2+
3+
FormStatsModel class
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**total_participant** | **int** | The number of participant for this event | [optional]
10+
**un_grouped_tiers** | [**List[HelloAssoApiV5CommonModelsFormsTierStatsModel]**](HelloAssoApiV5CommonModelsFormsTierStatsModel.md) | The list of ungrouped tiers, sorted as they must be displayed | [optional]
11+
**additional_options** | [**List[HelloAssoApiV5CommonModelsFormsTierStatsModel]**](HelloAssoApiV5CommonModelsFormsTierStatsModel.md) | The list of additional options, sorted as they must be displayed | [optional]
12+
13+
## Example
14+
15+
```python
16+
from helloasso_python.models.hello_asso_api_v5_common_models_forms_form_stats_model import HelloAssoApiV5CommonModelsFormsFormStatsModel
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of HelloAssoApiV5CommonModelsFormsFormStatsModel from a JSON string
21+
hello_asso_api_v5_common_models_forms_form_stats_model_instance = HelloAssoApiV5CommonModelsFormsFormStatsModel.from_json(json)
22+
# print the JSON string representation of the object
23+
print(HelloAssoApiV5CommonModelsFormsFormStatsModel.to_json())
24+
25+
# convert the object into a dict
26+
hello_asso_api_v5_common_models_forms_form_stats_model_dict = hello_asso_api_v5_common_models_forms_form_stats_model_instance.to_dict()
27+
# create an instance of HelloAssoApiV5CommonModelsFormsFormStatsModel from a dict
28+
hello_asso_api_v5_common_models_forms_form_stats_model_from_dict = HelloAssoApiV5CommonModelsFormsFormStatsModel.from_dict(hello_asso_api_v5_common_models_forms_form_stats_model_dict)
29+
```
30+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31+
32+

‎docs/HelloAssoApiV5CommonModelsFormsTierStatsModel.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# HelloAssoApiV5CommonModelsFormsTierStatsModel
2+
3+
TierStatsModel class
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**id** | **int** | id | [optional]
10+
**label** | **str** | label | [optional]
11+
**description** | **str** | description | [optional]
12+
**entries_taken** | **int** | The number of times this tier as been taken | [optional]
13+
**max_entries** | **int** | The max number of times this tier can be sold | [optional]
14+
**price** | **int** | the Price in cents if price equals 0 then it is free or there is a MinAmount | [optional]
15+
**min_amount** | **int** | If set, it means the payment is free to choose, according to the specified minAmount in cents | [optional]
16+
**price_category** | [**HelloAssoApiV5CommonModelsEnumsPriceCategory**](HelloAssoApiV5CommonModelsEnumsPriceCategory.md) | | [optional]
17+
**tier_type** | [**HelloAssoApiV5CommonModelsEnumsTierType**](HelloAssoApiV5CommonModelsEnumsTierType.md) | | [optional]
18+
**is_enabled** | **bool** | is true if tier state is ENABLED is false if tier state is DISABLED | [optional]
19+
20+
## Example
21+
22+
```python
23+
from helloasso_python.models.hello_asso_api_v5_common_models_forms_tier_stats_model import HelloAssoApiV5CommonModelsFormsTierStatsModel
24+
25+
# TODO update the JSON string below
26+
json = "{}"
27+
# create an instance of HelloAssoApiV5CommonModelsFormsTierStatsModel from a JSON string
28+
hello_asso_api_v5_common_models_forms_tier_stats_model_instance = HelloAssoApiV5CommonModelsFormsTierStatsModel.from_json(json)
29+
# print the JSON string representation of the object
30+
print(HelloAssoApiV5CommonModelsFormsTierStatsModel.to_json())
31+
32+
# convert the object into a dict
33+
hello_asso_api_v5_common_models_forms_tier_stats_model_dict = hello_asso_api_v5_common_models_forms_tier_stats_model_instance.to_dict()
34+
# create an instance of HelloAssoApiV5CommonModelsFormsTierStatsModel from a dict
35+
hello_asso_api_v5_common_models_forms_tier_stats_model_from_dict = HelloAssoApiV5CommonModelsFormsTierStatsModel.from_dict(hello_asso_api_v5_common_models_forms_tier_stats_model_dict)
36+
```
37+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
38+
39+

‎docs/HelloAssoApiV5CommonModelsOrganizationsOrganizationPublicModel.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
1212
**videos** | [**List[HelloAssoApiV5CommonModelsCommonVideoModel]**](HelloAssoApiV5CommonModelsCommonVideoModel.md) | | [optional]
1313
**web_site** | **str** | | [optional]
1414
**is_authenticated** | **bool** | The organization is authenticated. Property returned only when asked by an organization admin. | [optional]
15+
**display_coordinates** | **bool** | If the organization chose to display its coordinates. Property returned only when asked by an organization admin. | [optional]
1516
**is_cash_in_compliant** | **bool** | If transaction can be init on the organization or not. Property returned only when asked by an organization admin. | [optional]
1617
**banner** | **str** | The organization banner | [optional]
1718
**fiscal_receipt_eligibility** | **bool** | The organism can issue fiscal receipts (type ok and has not deactivated it) Must configure it and be authenticated to become enabled | [optional]

‎docs/HelloAssoApiV5CommonModelsStatisticsPaymentDetail.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8+
**card_expiration_date** | **datetime** | Card expiration date (only for card payments) | [optional]
89
**order** | [**HelloAssoApiV5CommonModelsStatisticsOrderLight**](HelloAssoApiV5CommonModelsStatisticsOrderLight.md) | | [optional]
910
**payer** | [**HelloAssoApiV5CommonModelsStatisticsPayer**](HelloAssoApiV5CommonModelsStatisticsPayer.md) | | [optional]
1011
**items** | [**List[HelloAssoApiV5CommonModelsStatisticsPaymentItem]**](HelloAssoApiV5CommonModelsStatisticsPaymentItem.md) | Items linked to this payment | [optional]

0 commit comments

Comments
 (0)