Skip to content

Commit ef0dca4

Browse files
author
gdgate
authored
Merge pull request #230 from hkad98/regenerate_clients
Regenerate clients Reviewed-by: Jan Soubusta https://github.com/jaceksan
2 parents fb10045 + a0497d2 commit ef0dca4

File tree

131 files changed

+5719
-4431
lines changed

Some content is hidden

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

131 files changed

+5719
-4431
lines changed

gooddata-api-client/.openapi-generator/FILES

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,7 @@ docs/OrganizationModelControllerApi.md
476476
docs/PDMDeclarativeAPIsApi.md
477477
docs/Paging.md
478478
docs/Parameter.md
479+
docs/PdfExportRequest.md
479480
docs/PdmLdmRequest.md
480481
docs/PdmSql.md
481482
docs/PermissionsApi.md
@@ -546,7 +547,7 @@ docs/UserPermission.md
546547
docs/UserSettingsApi.md
547548
docs/UsersDeclarativeAPIsApi.md
548549
docs/UsersEntityAPIsApi.md
549-
docs/VisualizationObjectApi.md
550+
docs/VisualizationObjectsApi.md
550551
docs/WorkspaceIdentifier.md
551552
docs/WorkspaceObjectControllerApi.md
552553
docs/WorkspacesDeclarativeAPIsApi.md
@@ -598,7 +599,7 @@ gooddata_api_client/api/user_model_controller_api.py
598599
gooddata_api_client/api/user_settings_api.py
599600
gooddata_api_client/api/users_declarative_apis_api.py
600601
gooddata_api_client/api/users_entity_apis_api.py
601-
gooddata_api_client/api/visualization_object_api.py
602+
gooddata_api_client/api/visualization_objects_api.py
602603
gooddata_api_client/api/workspace_object_controller_api.py
603604
gooddata_api_client/api/workspaces_declarative_apis_api.py
604605
gooddata_api_client/api/workspaces_entity_apis_api.py
@@ -1052,6 +1053,7 @@ gooddata_api_client/model/object_links.py
10521053
gooddata_api_client/model/object_links_container.py
10531054
gooddata_api_client/model/paging.py
10541055
gooddata_api_client/model/parameter.py
1056+
gooddata_api_client/model/pdf_export_request.py
10551057
gooddata_api_client/model/pdm_ldm_request.py
10561058
gooddata_api_client/model/pdm_sql.py
10571059
gooddata_api_client/model/permissions_for_assignee.py

gooddata-api-client/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,12 +235,12 @@ Class | Method | HTTP request | Description
235235
*UsersEntityAPIsApi* | [**get_entity_users**](docs/UsersEntityAPIsApi.md#get_entity_users) | **GET** /api/v1/entities/users/{id} |
236236
*UsersEntityAPIsApi* | [**patch_entity_users**](docs/UsersEntityAPIsApi.md#patch_entity_users) | **PATCH** /api/v1/entities/users/{id} |
237237
*UsersEntityAPIsApi* | [**update_entity_users**](docs/UsersEntityAPIsApi.md#update_entity_users) | **PUT** /api/v1/entities/users/{id} |
238-
*VisualizationObjectApi* | [**create_entity_visualization_objects**](docs/VisualizationObjectApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects |
239-
*VisualizationObjectApi* | [**delete_entity_visualization_objects**](docs/VisualizationObjectApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
240-
*VisualizationObjectApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects |
241-
*VisualizationObjectApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
242-
*VisualizationObjectApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
243-
*VisualizationObjectApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
238+
*VisualizationObjectsApi* | [**create_entity_visualization_objects**](docs/VisualizationObjectsApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects |
239+
*VisualizationObjectsApi* | [**delete_entity_visualization_objects**](docs/VisualizationObjectsApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
240+
*VisualizationObjectsApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectsApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects |
241+
*VisualizationObjectsApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectsApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
242+
*VisualizationObjectsApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectsApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
243+
*VisualizationObjectsApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectsApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} |
244244
*WorkspacesDeclarativeAPIsApi* | [**get_workspace_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspace_layout) | **GET** /api/v1/layout/workspaces/{workspaceId} | Get workspace layout
245245
*WorkspacesDeclarativeAPIsApi* | [**get_workspaces_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspaces_layout) | **GET** /api/v1/layout/workspaces | Get all workspaces layout
246246
*WorkspacesDeclarativeAPIsApi* | [**put_workspace_layout**](docs/WorkspacesDeclarativeAPIsApi.md#put_workspace_layout) | **PUT** /api/v1/layout/workspaces/{workspaceId} | Set workspace layout
@@ -271,12 +271,15 @@ Class | Method | HTTP request | Description
271271
*ActionsApi* | [**compute_label_elements_post**](docs/ActionsApi.md#compute_label_elements_post) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements | Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
272272
*ActionsApi* | [**compute_report**](docs/ActionsApi.md#compute_report) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute | Executes analytical request and returns link to the result
273273
*ActionsApi* | [**compute_valid_objects**](docs/ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects
274+
*ActionsApi* | [**create_pdf_export**](docs/ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request
274275
*ActionsApi* | [**create_tabular_export**](docs/ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request
275276
*ActionsApi* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource.
276277
*ActionsApi* | [**generate_logical_model**](docs/ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM)
277278
*ActionsApi* | [**get_data_source_schemata**](docs/ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database
278279
*ActionsApi* | [**get_dependent_entities_graph**](docs/ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph
279280
*ActionsApi* | [**get_dependent_entities_graph_from_entry_points**](docs/ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points
281+
*ActionsApi* | [**get_exported_file**](docs/ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files
282+
*ActionsApi* | [**get_metadata**](docs/ActionsApi.md#get_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata | Retrieve metadata context
280283
*ActionsApi* | [**get_tabular_export**](docs/ActionsApi.md#get_tabular_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files
281284
*ActionsApi* | [**inherited_entity_conflicts**](docs/ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds API identifier conflicts in given workspace hierarchy.
282285
*ActionsApi* | [**manage_permissions**](docs/ActionsApi.md#manage_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions |
@@ -1031,6 +1034,7 @@ Class | Method | HTTP request | Description
10311034
- [ObjectLinksContainer](docs/ObjectLinksContainer.md)
10321035
- [Paging](docs/Paging.md)
10331036
- [Parameter](docs/Parameter.md)
1037+
- [PdfExportRequest](docs/PdfExportRequest.md)
10341038
- [PdmLdmRequest](docs/PdmLdmRequest.md)
10351039
- [PdmSql](docs/PdmSql.md)
10361040
- [PermissionsForAssignee](docs/PermissionsForAssignee.md)

gooddata-api-client/docs/ActionsApi.md

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@ Method | HTTP request | Description
1010
[**compute_label_elements_post**](ActionsApi.md#compute_label_elements_post) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements | Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
1111
[**compute_report**](ActionsApi.md#compute_report) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute | Executes analytical request and returns link to the result
1212
[**compute_valid_objects**](ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects
13+
[**create_pdf_export**](ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request
1314
[**create_tabular_export**](ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request
1415
[**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource.
1516
[**generate_logical_model**](ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM)
1617
[**get_data_source_schemata**](ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database
1718
[**get_dependent_entities_graph**](ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph
1819
[**get_dependent_entities_graph_from_entry_points**](ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points
20+
[**get_exported_file**](ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files
21+
[**get_metadata**](ActionsApi.md#get_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata | Retrieve metadata context
1922
[**get_tabular_export**](ActionsApi.md#get_tabular_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files
2023
[**inherited_entity_conflicts**](ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds API identifier conflicts in given workspace hierarchy.
2124
[**manage_permissions**](ActionsApi.md#manage_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions |
@@ -582,6 +585,80 @@ No authorization required
582585

583586
[[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)
584587

588+
# **create_pdf_export**
589+
> ExportResponse create_pdf_export(workspace_id, pdf_export_request)
590+
591+
Create visual - pdf export request
592+
593+
An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
594+
595+
### Example
596+
597+
598+
```python
599+
import time
600+
import gooddata_api_client
601+
from gooddata_api_client.api import actions_api
602+
from gooddata_api_client.model.export_response import ExportResponse
603+
from gooddata_api_client.model.pdf_export_request import PdfExportRequest
604+
from pprint import pprint
605+
# Defining the host is optional and defaults to http://localhost
606+
# See configuration.py for a list of all supported configuration parameters.
607+
configuration = gooddata_api_client.Configuration(
608+
host = "http://localhost"
609+
)
610+
611+
612+
# Enter a context with an instance of the API client
613+
with gooddata_api_client.ApiClient() as api_client:
614+
# Create an instance of the API class
615+
api_instance = actions_api.ActionsApi(api_client)
616+
workspace_id = "workspaceId_example" # str |
617+
pdf_export_request = PdfExportRequest(
618+
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
619+
file_name="filename",
620+
metadata={},
621+
) # PdfExportRequest |
622+
623+
# example passing only required values which don't have defaults set
624+
try:
625+
# Create visual - pdf export request
626+
api_response = api_instance.create_pdf_export(workspace_id, pdf_export_request)
627+
pprint(api_response)
628+
except gooddata_api_client.ApiException as e:
629+
print("Exception when calling ActionsApi->create_pdf_export: %s\n" % e)
630+
```
631+
632+
633+
### Parameters
634+
635+
Name | Type | Description | Notes
636+
------------- | ------------- | ------------- | -------------
637+
**workspace_id** | **str**| |
638+
**pdf_export_request** | [**PdfExportRequest**](PdfExportRequest.md)| |
639+
640+
### Return type
641+
642+
[**ExportResponse**](ExportResponse.md)
643+
644+
### Authorization
645+
646+
No authorization required
647+
648+
### HTTP request headers
649+
650+
- **Content-Type**: application/json
651+
- **Accept**: application/json
652+
653+
654+
### HTTP response details
655+
656+
| Status code | Description | Response headers |
657+
|-------------|-------------|------------------|
658+
**201** | Visual export request created successfully. | - |
659+
660+
[[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)
661+
585662
# **create_tabular_export**
586663
> ExportResponse create_tabular_export(workspace_id, tabular_export_request)
587664
@@ -1117,6 +1194,141 @@ No authorization required
11171194

11181195
[[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)
11191196

1197+
# **get_exported_file**
1198+
> get_exported_file(workspace_id, export_id)
1199+
1200+
Retrieve exported files
1201+
1202+
Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1203+
1204+
### Example
1205+
1206+
1207+
```python
1208+
import time
1209+
import gooddata_api_client
1210+
from gooddata_api_client.api import actions_api
1211+
from pprint import pprint
1212+
# Defining the host is optional and defaults to http://localhost
1213+
# See configuration.py for a list of all supported configuration parameters.
1214+
configuration = gooddata_api_client.Configuration(
1215+
host = "http://localhost"
1216+
)
1217+
1218+
1219+
# Enter a context with an instance of the API client
1220+
with gooddata_api_client.ApiClient() as api_client:
1221+
# Create an instance of the API class
1222+
api_instance = actions_api.ActionsApi(api_client)
1223+
workspace_id = "workspaceId_example" # str |
1224+
export_id = "exportId_example" # str |
1225+
1226+
# example passing only required values which don't have defaults set
1227+
try:
1228+
# Retrieve exported files
1229+
api_instance.get_exported_file(workspace_id, export_id)
1230+
except gooddata_api_client.ApiException as e:
1231+
print("Exception when calling ActionsApi->get_exported_file: %s\n" % e)
1232+
```
1233+
1234+
1235+
### Parameters
1236+
1237+
Name | Type | Description | Notes
1238+
------------- | ------------- | ------------- | -------------
1239+
**workspace_id** | **str**| |
1240+
**export_id** | **str**| |
1241+
1242+
### Return type
1243+
1244+
void (empty response body)
1245+
1246+
### Authorization
1247+
1248+
No authorization required
1249+
1250+
### HTTP request headers
1251+
1252+
- **Content-Type**: Not defined
1253+
- **Accept**: application/pdf
1254+
1255+
1256+
### HTTP response details
1257+
1258+
| Status code | Description | Response headers |
1259+
|-------------|-------------|------------------|
1260+
**200** | Binary export result. | * Content-Disposition - <br> |
1261+
**202** | Request is accepted, provided exportId exists, but export is not yet ready. | - |
1262+
1263+
[[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)
1264+
1265+
# **get_metadata**
1266+
> get_metadata(workspace_id, export_id)
1267+
1268+
Retrieve metadata context
1269+
1270+
This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
1271+
1272+
### Example
1273+
1274+
1275+
```python
1276+
import time
1277+
import gooddata_api_client
1278+
from gooddata_api_client.api import actions_api
1279+
from pprint import pprint
1280+
# Defining the host is optional and defaults to http://localhost
1281+
# See configuration.py for a list of all supported configuration parameters.
1282+
configuration = gooddata_api_client.Configuration(
1283+
host = "http://localhost"
1284+
)
1285+
1286+
1287+
# Enter a context with an instance of the API client
1288+
with gooddata_api_client.ApiClient() as api_client:
1289+
# Create an instance of the API class
1290+
api_instance = actions_api.ActionsApi(api_client)
1291+
workspace_id = "workspaceId_example" # str |
1292+
export_id = "exportId_example" # str |
1293+
1294+
# example passing only required values which don't have defaults set
1295+
try:
1296+
# Retrieve metadata context
1297+
api_instance.get_metadata(workspace_id, export_id)
1298+
except gooddata_api_client.ApiException as e:
1299+
print("Exception when calling ActionsApi->get_metadata: %s\n" % e)
1300+
```
1301+
1302+
1303+
### Parameters
1304+
1305+
Name | Type | Description | Notes
1306+
------------- | ------------- | ------------- | -------------
1307+
**workspace_id** | **str**| |
1308+
**export_id** | **str**| |
1309+
1310+
### Return type
1311+
1312+
void (empty response body)
1313+
1314+
### Authorization
1315+
1316+
No authorization required
1317+
1318+
### HTTP request headers
1319+
1320+
- **Content-Type**: Not defined
1321+
- **Accept**: application/json
1322+
1323+
1324+
### HTTP response details
1325+
1326+
| Status code | Description | Response headers |
1327+
|-------------|-------------|------------------|
1328+
**200** | Json metadata representation | - |
1329+
1330+
[[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)
1331+
11201332
# **get_tabular_export**
11211333
> get_tabular_export(workspace_id, export_id)
11221334
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# PdfExportRequest
2+
3+
Export request object describing the export properties and metadata for pdf exports.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**dashboard_id** | **str** | Dashboard identifier |
9+
**file_name** | **str** | File name to be used for retrieving the pdf document. |
10+
**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Custom setting content in JSON format. | [optional]
11+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

0 commit comments

Comments
 (0)