|
| 1 | +# hostinger_api.WordPressAIToolsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://developers.hostinger.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**set_ai_option_status_v1**](WordPressAIToolsApi.md#set_ai_option_status_v1) | **PATCH** /api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status | Set AI option status |
| 8 | +[**show_ai_option_status_v1**](WordPressAIToolsApi.md#show_ai_option_status_v1) | **GET** /api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status | Show AI option status |
| 9 | + |
| 10 | + |
| 11 | +# **set_ai_option_status_v1** |
| 12 | +> CommonSuccessEmptyResource set_ai_option_status_v1(username, software, word_press_v1_hostinger_plugins_update_ai_option_status_request) |
| 13 | +
|
| 14 | +Set AI option status |
| 15 | + |
| 16 | +Enable or disable an AI option for the Hostinger Tools plugin on the specified |
| 17 | +WordPress installation. |
| 18 | + |
| 19 | +Provide the WordPress installation (software) identifier in the path. It can |
| 20 | +be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). |
| 21 | + |
| 22 | +### Example |
| 23 | + |
| 24 | +* Bearer Authentication (apiToken): |
| 25 | + |
| 26 | +```python |
| 27 | +import hostinger_api |
| 28 | +from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource |
| 29 | +from hostinger_api.models.word_press_v1_hostinger_plugins_update_ai_option_status_request import WordPressV1HostingerPluginsUpdateAiOptionStatusRequest |
| 30 | +from hostinger_api.rest import ApiException |
| 31 | +from pprint import pprint |
| 32 | + |
| 33 | + |
| 34 | +# Configure Bearer authorization: apiToken |
| 35 | +configuration = hostinger_api.Configuration( |
| 36 | + access_token = os.environ["BEARER_TOKEN"] |
| 37 | +) |
| 38 | + |
| 39 | +# Enter a context with an instance of the API client |
| 40 | +with hostinger_api.ApiClient(configuration) as api_client: |
| 41 | + # Create an instance of the API class |
| 42 | + api_instance = hostinger_api.WordPressAIToolsApi(api_client) |
| 43 | + username = 'u123456789' # str | |
| 44 | + software = '1232456789' # str | WordPress installation (software) identifier |
| 45 | + word_press_v1_hostinger_plugins_update_ai_option_status_request = hostinger_api.WordPressV1HostingerPluginsUpdateAiOptionStatusRequest() # WordPressV1HostingerPluginsUpdateAiOptionStatusRequest | |
| 46 | + |
| 47 | + try: |
| 48 | + # Set AI option status |
| 49 | + api_response = api_instance.set_ai_option_status_v1(username, software, word_press_v1_hostinger_plugins_update_ai_option_status_request) |
| 50 | + print("The response of WordPressAIToolsApi->set_ai_option_status_v1:\n") |
| 51 | + pprint(api_response) |
| 52 | + except Exception as e: |
| 53 | + print("Exception when calling WordPressAIToolsApi->set_ai_option_status_v1: %s\n" % e) |
| 54 | +``` |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +### Parameters |
| 59 | + |
| 60 | + |
| 61 | +Name | Type | Description | Notes |
| 62 | +------------- | ------------- | ------------- | ------------- |
| 63 | + **username** | **str**| | |
| 64 | + **software** | **str**| WordPress installation (software) identifier | |
| 65 | + **word_press_v1_hostinger_plugins_update_ai_option_status_request** | [**WordPressV1HostingerPluginsUpdateAiOptionStatusRequest**](WordPressV1HostingerPluginsUpdateAiOptionStatusRequest.md)| | |
| 66 | + |
| 67 | +### Return type |
| 68 | + |
| 69 | +[**CommonSuccessEmptyResource**](CommonSuccessEmptyResource.md) |
| 70 | + |
| 71 | +### Authorization |
| 72 | + |
| 73 | +[apiToken](../README.md#apiToken) |
| 74 | + |
| 75 | +### HTTP request headers |
| 76 | + |
| 77 | + - **Content-Type**: application/json |
| 78 | + - **Accept**: application/json |
| 79 | + |
| 80 | +### HTTP response details |
| 81 | + |
| 82 | +| Status code | Description | Response headers | |
| 83 | +|-------------|-------------|------------------| |
| 84 | +**200** | Success empty response | - | |
| 85 | +**422** | Validation error response | - | |
| 86 | +**401** | Unauthenticated response | - | |
| 87 | +**500** | Error response | - | |
| 88 | + |
| 89 | +[[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) |
| 90 | + |
| 91 | +# **show_ai_option_status_v1** |
| 92 | +> WordPressV1HostingerPluginsAiOptionStatusResource show_ai_option_status_v1(username, software, option=option) |
| 93 | +
|
| 94 | +Show AI option status |
| 95 | + |
| 96 | +Show the current AI option status for the Hostinger Tools plugin on the |
| 97 | +specified WordPress installation. Filter by `option` to return a single |
| 98 | +option, or omit it to return all options. |
| 99 | + |
| 100 | +Provide the WordPress installation (software) identifier in the path. It can |
| 101 | +be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). |
| 102 | + |
| 103 | +### Example |
| 104 | + |
| 105 | +* Bearer Authentication (apiToken): |
| 106 | + |
| 107 | +```python |
| 108 | +import hostinger_api |
| 109 | +from hostinger_api.models.word_press_v1_hostinger_plugins_ai_option_status_resource import WordPressV1HostingerPluginsAiOptionStatusResource |
| 110 | +from hostinger_api.rest import ApiException |
| 111 | +from pprint import pprint |
| 112 | + |
| 113 | + |
| 114 | +# Configure Bearer authorization: apiToken |
| 115 | +configuration = hostinger_api.Configuration( |
| 116 | + access_token = os.environ["BEARER_TOKEN"] |
| 117 | +) |
| 118 | + |
| 119 | +# Enter a context with an instance of the API client |
| 120 | +with hostinger_api.ApiClient(configuration) as api_client: |
| 121 | + # Create an instance of the API class |
| 122 | + api_instance = hostinger_api.WordPressAIToolsApi(api_client) |
| 123 | + username = 'u123456789' # str | |
| 124 | + software = '1232456789' # str | WordPress installation (software) identifier |
| 125 | + option = 'llmstxt' # str | Filter the status by a single AI option. (optional) |
| 126 | + |
| 127 | + try: |
| 128 | + # Show AI option status |
| 129 | + api_response = api_instance.show_ai_option_status_v1(username, software, option=option) |
| 130 | + print("The response of WordPressAIToolsApi->show_ai_option_status_v1:\n") |
| 131 | + pprint(api_response) |
| 132 | + except Exception as e: |
| 133 | + print("Exception when calling WordPressAIToolsApi->show_ai_option_status_v1: %s\n" % e) |
| 134 | +``` |
| 135 | + |
| 136 | + |
| 137 | + |
| 138 | +### Parameters |
| 139 | + |
| 140 | + |
| 141 | +Name | Type | Description | Notes |
| 142 | +------------- | ------------- | ------------- | ------------- |
| 143 | + **username** | **str**| | |
| 144 | + **software** | **str**| WordPress installation (software) identifier | |
| 145 | + **option** | **str**| Filter the status by a single AI option. | [optional] |
| 146 | + |
| 147 | +### Return type |
| 148 | + |
| 149 | +[**WordPressV1HostingerPluginsAiOptionStatusResource**](WordPressV1HostingerPluginsAiOptionStatusResource.md) |
| 150 | + |
| 151 | +### Authorization |
| 152 | + |
| 153 | +[apiToken](../README.md#apiToken) |
| 154 | + |
| 155 | +### HTTP request headers |
| 156 | + |
| 157 | + - **Content-Type**: Not defined |
| 158 | + - **Accept**: application/json |
| 159 | + |
| 160 | +### HTTP response details |
| 161 | + |
| 162 | +| Status code | Description | Response headers | |
| 163 | +|-------------|-------------|------------------| |
| 164 | +**200** | Success response | - | |
| 165 | +**401** | Unauthenticated response | - | |
| 166 | +**500** | Error response | - | |
| 167 | + |
| 168 | +[[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) |
| 169 | + |
![hostingerbot[bot]](https://avatars.githubusercontent.com/in/1033565?v=4&size=40){kind=avatar}
0 commit comments