|
| 1 | +# helloasso_python.OrganizationPublicConfigurationsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.helloasso.com/v5* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**organizations_organization_slug_configurations_get**](OrganizationPublicConfigurationsApi.md#organizations_organization_slug_configurations_get) | **GET** /organizations/{organizationSlug}/configurations | |
| 8 | +[**organizations_organization_slug_configurations_put**](OrganizationPublicConfigurationsApi.md#organizations_organization_slug_configurations_put) | **PUT** /organizations/{organizationSlug}/configurations | |
| 9 | + |
| 10 | + |
| 11 | +# **organizations_organization_slug_configurations_get** |
| 12 | +> List[HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationModel] organizations_organization_slug_configurations_get(organization_slug) |
| 13 | +
|
| 14 | +<br/><br/><b>Your token must have one of these roles : </b><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/> OrganizationAdministration<br/><br/> |
| 15 | + |
| 16 | +### Example |
| 17 | + |
| 18 | + |
| 19 | +```python |
| 20 | +import helloasso_python |
| 21 | +from helloasso_python.models.hello_asso_api_v5_models_organizations_organization_public_configuration_model import HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationModel |
| 22 | +from helloasso_python.rest import ApiException |
| 23 | +from pprint import pprint |
| 24 | + |
| 25 | +# Defining the host is optional and defaults to https://api.helloasso.com/v5 |
| 26 | +# See configuration.py for a list of all supported configuration parameters. |
| 27 | +configuration = helloasso_python.Configuration( |
| 28 | + host = "https://api.helloasso.com/v5" |
| 29 | +) |
| 30 | + |
| 31 | + |
| 32 | +# Enter a context with an instance of the API client |
| 33 | +with helloasso_python.ApiClient(configuration) as api_client: |
| 34 | + # Create an instance of the API class |
| 35 | + api_instance = helloasso_python.OrganizationPublicConfigurationsApi(api_client) |
| 36 | + organization_slug = 'organization_slug_example' # str | |
| 37 | + |
| 38 | + try: |
| 39 | + api_response = api_instance.organizations_organization_slug_configurations_get(organization_slug) |
| 40 | + print("The response of OrganizationPublicConfigurationsApi->organizations_organization_slug_configurations_get:\n") |
| 41 | + pprint(api_response) |
| 42 | + except Exception as e: |
| 43 | + print("Exception when calling OrganizationPublicConfigurationsApi->organizations_organization_slug_configurations_get: %s\n" % e) |
| 44 | +``` |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +### Parameters |
| 49 | + |
| 50 | + |
| 51 | +Name | Type | Description | Notes |
| 52 | +------------- | ------------- | ------------- | ------------- |
| 53 | + **organization_slug** | **str**| | |
| 54 | + |
| 55 | +### Return type |
| 56 | + |
| 57 | +[**List[HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationModel]**](HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationModel.md) |
| 58 | + |
| 59 | +### Authorization |
| 60 | + |
| 61 | +No authorization required |
| 62 | + |
| 63 | +### HTTP request headers |
| 64 | + |
| 65 | + - **Content-Type**: Not defined |
| 66 | + - **Accept**: text/plain, application/json, text/json |
| 67 | + |
| 68 | +### HTTP response details |
| 69 | + |
| 70 | +| Status code | Description | Response headers | |
| 71 | +|-------------|-------------|------------------| |
| 72 | +**200** | Success | - | |
| 73 | +**401** | Unauthorized, you must add a valid JWT into Authorization Header with the format : `Bearer TOKEN` | - | |
| 74 | +**403** | The JWT token hasn't the privileges or Roles for this action | - | |
| 75 | + |
| 76 | +[[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) |
| 77 | + |
| 78 | +# **organizations_organization_slug_configurations_put** |
| 79 | +> organizations_organization_slug_configurations_put(organization_slug, hello_asso_api_v5_models_organizations_organization_public_configurations_request=hello_asso_api_v5_models_organizations_organization_public_configurations_request) |
| 80 | +
|
| 81 | +<br/><br/><b>Your token must have one of these roles : </b><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/> OrganizationAdministration<br/><br/> |
| 82 | + |
| 83 | +### Example |
| 84 | + |
| 85 | + |
| 86 | +```python |
| 87 | +import helloasso_python |
| 88 | +from helloasso_python.models.hello_asso_api_v5_models_organizations_organization_public_configurations_request import HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationsRequest |
| 89 | +from helloasso_python.rest import ApiException |
| 90 | +from pprint import pprint |
| 91 | + |
| 92 | +# Defining the host is optional and defaults to https://api.helloasso.com/v5 |
| 93 | +# See configuration.py for a list of all supported configuration parameters. |
| 94 | +configuration = helloasso_python.Configuration( |
| 95 | + host = "https://api.helloasso.com/v5" |
| 96 | +) |
| 97 | + |
| 98 | + |
| 99 | +# Enter a context with an instance of the API client |
| 100 | +with helloasso_python.ApiClient(configuration) as api_client: |
| 101 | + # Create an instance of the API class |
| 102 | + api_instance = helloasso_python.OrganizationPublicConfigurationsApi(api_client) |
| 103 | + organization_slug = 'organization_slug_example' # str | |
| 104 | + hello_asso_api_v5_models_organizations_organization_public_configurations_request = helloasso_python.HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationsRequest() # HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationsRequest | (optional) |
| 105 | + |
| 106 | + try: |
| 107 | + api_instance.organizations_organization_slug_configurations_put(organization_slug, hello_asso_api_v5_models_organizations_organization_public_configurations_request=hello_asso_api_v5_models_organizations_organization_public_configurations_request) |
| 108 | + except Exception as e: |
| 109 | + print("Exception when calling OrganizationPublicConfigurationsApi->organizations_organization_slug_configurations_put: %s\n" % e) |
| 110 | +``` |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +### Parameters |
| 115 | + |
| 116 | + |
| 117 | +Name | Type | Description | Notes |
| 118 | +------------- | ------------- | ------------- | ------------- |
| 119 | + **organization_slug** | **str**| | |
| 120 | + **hello_asso_api_v5_models_organizations_organization_public_configurations_request** | [**HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationsRequest**](HelloAssoApiV5ModelsOrganizationsOrganizationPublicConfigurationsRequest.md)| | [optional] |
| 121 | + |
| 122 | +### Return type |
| 123 | + |
| 124 | +void (empty response body) |
| 125 | + |
| 126 | +### Authorization |
| 127 | + |
| 128 | +No authorization required |
| 129 | + |
| 130 | +### HTTP request headers |
| 131 | + |
| 132 | + - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json |
| 133 | + - **Accept**: Not defined |
| 134 | + |
| 135 | +### HTTP response details |
| 136 | + |
| 137 | +| Status code | Description | Response headers | |
| 138 | +|-------------|-------------|------------------| |
| 139 | +**204** | No Content | - | |
| 140 | +**400** | Bad Request | - | |
| 141 | +**401** | Unauthorized, you must add a valid JWT into Authorization Header with the format : `Bearer TOKEN` | - | |
| 142 | +**403** | The JWT token hasn't the privileges or Roles for this action | - | |
| 143 | + |
| 144 | +[[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) |
| 145 | + |
0 commit comments