Skip to content

Commit eb53f57

Browse files
hkad98hkad98
committed
trivial(api client): regenerate API client
1 parent d846957 commit eb53f57

14 files changed

+562
-12
lines changed

‎gooddata-api-client/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ Class | Method | HTTP request | Description
251251
*TestConnectionApi* | [**test_data_source_definition**](docs/TestConnectionApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
252252
*TranslationsApi* | [**clean_translations**](docs/TranslationsApi.md#clean_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/clean | Cleans up translations.
253253
*TranslationsApi* | [**get_translation_tags**](docs/TranslationsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags.
254+
*TranslationsApi* | [**retrieve_translations**](docs/TranslationsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities.
254255
*TranslationsApi* | [**set_translations**](docs/TranslationsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities.
255256
*UsageApi* | [**all_platform_usage**](docs/UsageApi.md#all_platform_usage) | **GET** /api/v1/actions/collectUsage | Info about the platform usage.
256257
*UsageApi* | [**particular_platform_usage**](docs/UsageApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items.
@@ -355,6 +356,7 @@ Class | Method | HTTP request | Description
355356
*ActionsApi* | [**resolve_settings_without_workspace**](docs/ActionsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace.
356357
*ActionsApi* | [**retrieve_execution_metadata**](docs/ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata.
357358
*ActionsApi* | [**retrieve_result**](docs/ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result
359+
*ActionsApi* | [**retrieve_translations**](docs/ActionsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities.
358360
*ActionsApi* | [**scan_data_source**](docs/ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)
359361
*ActionsApi* | [**scan_sql**](docs/ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query
360362
*ActionsApi* | [**set_translations**](docs/ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities.

‎gooddata-api-client/docs/ActionsApi.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Method | HTTP request | Description
4848
[**resolve_settings_without_workspace**](ActionsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace.
4949
[**retrieve_execution_metadata**](ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata.
5050
[**retrieve_result**](ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result
51+
[**retrieve_translations**](ActionsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities.
5152
[**scan_data_source**](ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)
5253
[**scan_sql**](ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query
5354
[**set_translations**](ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities.
@@ -3407,6 +3408,78 @@ No authorization required
34073408

34083409
[[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)
34093410

3411+
# **retrieve_translations**
3412+
> Xliff retrieve_translations(workspace_id, locale_request)
3413+
3414+
Retrieve translations for entities.
3415+
3416+
Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. If you use the special 'default' locale value in the request, only source translations are returned.
3417+
3418+
### Example
3419+
3420+
3421+
```python
3422+
import time
3423+
import gooddata_api_client
3424+
from gooddata_api_client.api import actions_api
3425+
from gooddata_api_client.model.locale_request import LocaleRequest
3426+
from gooddata_api_client.model.xliff import Xliff
3427+
from pprint import pprint
3428+
# Defining the host is optional and defaults to http://localhost
3429+
# See configuration.py for a list of all supported configuration parameters.
3430+
configuration = gooddata_api_client.Configuration(
3431+
host = "http://localhost"
3432+
)
3433+
3434+
3435+
# Enter a context with an instance of the API client
3436+
with gooddata_api_client.ApiClient() as api_client:
3437+
# Create an instance of the API class
3438+
api_instance = actions_api.ActionsApi(api_client)
3439+
workspace_id = "workspaceId_example" # str |
3440+
locale_request = LocaleRequest(
3441+
locale="en-US",
3442+
) # LocaleRequest |
3443+
3444+
# example passing only required values which don't have defaults set
3445+
try:
3446+
# Retrieve translations for entities.
3447+
api_response = api_instance.retrieve_translations(workspace_id, locale_request)
3448+
pprint(api_response)
3449+
except gooddata_api_client.ApiException as e:
3450+
print("Exception when calling ActionsApi->retrieve_translations: %s\n" % e)
3451+
```
3452+
3453+
3454+
### Parameters
3455+
3456+
Name | Type | Description | Notes
3457+
------------- | ------------- | ------------- | -------------
3458+
**workspace_id** | **str**| |
3459+
**locale_request** | [**LocaleRequest**](LocaleRequest.md)| |
3460+
3461+
### Return type
3462+
3463+
[**Xliff**](Xliff.md)
3464+
3465+
### Authorization
3466+
3467+
No authorization required
3468+
3469+
### HTTP request headers
3470+
3471+
- **Content-Type**: application/json
3472+
- **Accept**: application/xml
3473+
3474+
3475+
### HTTP response details
3476+
3477+
| Status code | Description | Response headers |
3478+
|-------------|-------------|------------------|
3479+
**200** | XLIFF file containing translations for a particular locale. | - |
3480+
3481+
[[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)
3482+
34103483
# **scan_data_source**
34113484
> ScanResultPdm scan_data_source(data_source_id, scan_request)
34123485

‎gooddata-api-client/docs/TranslationsApi.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**clean_translations**](TranslationsApi.md#clean_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/clean | Cleans up translations.
88
[**get_translation_tags**](TranslationsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags.
9+
[**retrieve_translations**](TranslationsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities.
910
[**set_translations**](TranslationsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities.
1011

1112

@@ -145,6 +146,78 @@ No authorization required
145146

146147
[[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)
147148

149+
# **retrieve_translations**
150+
> Xliff retrieve_translations(workspace_id, locale_request)
151+
152+
Retrieve translations for entities.
153+
154+
Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. If you use the special 'default' locale value in the request, only source translations are returned.
155+
156+
### Example
157+
158+
159+
```python
160+
import time
161+
import gooddata_api_client
162+
from gooddata_api_client.api import translations_api
163+
from gooddata_api_client.model.locale_request import LocaleRequest
164+
from gooddata_api_client.model.xliff import Xliff
165+
from pprint import pprint
166+
# Defining the host is optional and defaults to http://localhost
167+
# See configuration.py for a list of all supported configuration parameters.
168+
configuration = gooddata_api_client.Configuration(
169+
host = "http://localhost"
170+
)
171+
172+
173+
# Enter a context with an instance of the API client
174+
with gooddata_api_client.ApiClient() as api_client:
175+
# Create an instance of the API class
176+
api_instance = translations_api.TranslationsApi(api_client)
177+
workspace_id = "workspaceId_example" # str |
178+
locale_request = LocaleRequest(
179+
locale="en-US",
180+
) # LocaleRequest |
181+
182+
# example passing only required values which don't have defaults set
183+
try:
184+
# Retrieve translations for entities.
185+
api_response = api_instance.retrieve_translations(workspace_id, locale_request)
186+
pprint(api_response)
187+
except gooddata_api_client.ApiException as e:
188+
print("Exception when calling TranslationsApi->retrieve_translations: %s\n" % e)
189+
```
190+
191+
192+
### Parameters
193+
194+
Name | Type | Description | Notes
195+
------------- | ------------- | ------------- | -------------
196+
**workspace_id** | **str**| |
197+
**locale_request** | [**LocaleRequest**](LocaleRequest.md)| |
198+
199+
### Return type
200+
201+
[**Xliff**](Xliff.md)
202+
203+
### Authorization
204+
205+
No authorization required
206+
207+
### HTTP request headers
208+
209+
- **Content-Type**: application/json
210+
- **Accept**: application/xml
211+
212+
213+
### HTTP response details
214+
215+
| Status code | Description | Response headers |
216+
|-------------|-------------|------------------|
217+
**200** | XLIFF file containing translations for a particular locale. | - |
218+
219+
[[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)
220+
148221
# **set_translations**
149222
> set_translations(workspace_id, xliff)
150223

‎gooddata-api-client/gooddata_api_client/api/actions_api.py‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,6 +2493,62 @@ def __init__(self, api_client=None):
24932493
},
24942494
api_client=api_client
24952495
)
2496+
self.retrieve_translations_endpoint = _Endpoint(
2497+
settings={
2498+
'response_type': (Xliff,),
2499+
'auth': [],
2500+
'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/retrieve',
2501+
'operation_id': 'retrieve_translations',
2502+
'http_method': 'POST',
2503+
'servers': None,
2504+
},
2505+
params_map={
2506+
'all': [
2507+
'workspace_id',
2508+
'locale_request',
2509+
],
2510+
'required': [
2511+
'workspace_id',
2512+
'locale_request',
2513+
],
2514+
'nullable': [
2515+
],
2516+
'enum': [
2517+
],
2518+
'validation': [
2519+
]
2520+
},
2521+
root_map={
2522+
'validations': {
2523+
},
2524+
'allowed_values': {
2525+
},
2526+
'openapi_types': {
2527+
'workspace_id':
2528+
(str,),
2529+
'locale_request':
2530+
(LocaleRequest,),
2531+
},
2532+
'attribute_map': {
2533+
'workspace_id': 'workspaceId',
2534+
},
2535+
'location_map': {
2536+
'workspace_id': 'path',
2537+
'locale_request': 'body',
2538+
},
2539+
'collection_format_map': {
2540+
}
2541+
},
2542+
headers_map={
2543+
'accept': [
2544+
'application/xml'
2545+
],
2546+
'content_type': [
2547+
'application/json'
2548+
]
2549+
},
2550+
api_client=api_client
2551+
)
24962552
self.scan_data_source_endpoint = _Endpoint(
24972553
settings={
24982554
'response_type': (ScanResultPdm,),
@@ -6620,6 +6676,93 @@ def retrieve_result(
66206676
result_id
66216677
return self.retrieve_result_endpoint.call_with_http_info(**kwargs)
66226678

6679+
def retrieve_translations(
6680+
self,
6681+
workspace_id,
6682+
locale_request,
6683+
**kwargs
6684+
):
6685+
"""Retrieve translations for entities. # noqa: E501
6686+
6687+
Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value. If you use the special 'default' locale value in the request, only source translations are returned. # noqa: E501
6688+
This method makes a synchronous HTTP request by default. To make an
6689+
asynchronous HTTP request, please pass async_req=True
6690+
6691+
>>> thread = api.retrieve_translations(workspace_id, locale_request, async_req=True)
6692+
>>> result = thread.get()
6693+
6694+
Args:
6695+
workspace_id (str):
6696+
locale_request (LocaleRequest):
6697+
6698+
Keyword Args:
6699+
_return_http_data_only (bool): response data without head status
6700+
code and headers. Default is True.
6701+
_preload_content (bool): if False, the urllib3.HTTPResponse object
6702+
will be returned without reading/decoding response data.
6703+
Default is True.
6704+
_request_timeout (int/float/tuple): timeout setting for this request. If
6705+
one number provided, it will be total request timeout. It can also
6706+
be a pair (tuple) of (connection, read) timeouts.
6707+
Default is None.
6708+
_check_input_type (bool): specifies if type checking
6709+
should be done one the data sent to the server.
6710+
Default is True.
6711+
_check_return_type (bool): specifies if type checking
6712+
should be done one the data received from the server.
6713+
Default is True.
6714+
_spec_property_naming (bool): True if the variable names in the input data
6715+
are serialized names, as specified in the OpenAPI document.
6716+
False if the variable names in the input data
6717+
are pythonic names, e.g. snake case (default)
6718+
_content_type (str/None): force body content-type.
6719+
Default is None and content-type will be predicted by allowed
6720+
content-types and body.
6721+
_host_index (int/None): specifies the index of the server
6722+
that we want to use.
6723+
Default is read from the configuration.
6724+
_request_auths (list): set to override the auth_settings for an a single
6725+
request; this effectively ignores the authentication
6726+
in the spec for a single request.
6727+
Default is None
6728+
async_req (bool): execute request asynchronously
6729+
6730+
Returns:
6731+
Xliff
6732+
If the method is called asynchronously, returns the request
6733+
thread.
6734+
"""
6735+
kwargs['async_req'] = kwargs.get(
6736+
'async_req', False
6737+
)
6738+
kwargs['_return_http_data_only'] = kwargs.get(
6739+
'_return_http_data_only', True
6740+
)
6741+
kwargs['_preload_content'] = kwargs.get(
6742+
'_preload_content', True
6743+
)
6744+
kwargs['_request_timeout'] = kwargs.get(
6745+
'_request_timeout', None
6746+
)
6747+
kwargs['_check_input_type'] = kwargs.get(
6748+
'_check_input_type', True
6749+
)
6750+
kwargs['_check_return_type'] = kwargs.get(
6751+
'_check_return_type', True
6752+
)
6753+
kwargs['_spec_property_naming'] = kwargs.get(
6754+
'_spec_property_naming', False
6755+
)
6756+
kwargs['_content_type'] = kwargs.get(
6757+
'_content_type')
6758+
kwargs['_host_index'] = kwargs.get('_host_index')
6759+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
6760+
kwargs['workspace_id'] = \
6761+
workspace_id
6762+
kwargs['locale_request'] = \
6763+
locale_request
6764+
return self.retrieve_translations_endpoint.call_with_http_info(**kwargs)
6765+
66236766
def scan_data_source(
66246767
self,
66256768
data_source_id,

0 commit comments

Comments
 (0)