Skip to content

Commit e777611

Browse files
no23reasonno23reason
committed
chore: re-generate client
Add the possibility to pass ExecutionSettings to Raw Exports. JIRA: CQ-1206 risk: low
1 parent 6864fc7 commit e777611

Some content is hidden

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

41 files changed

+3038
-99
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ docs/AbsoluteDateFilterAbsoluteDateFilter.md
88
docs/AbstractMeasureValueFilter.md
99
docs/ActionsApi.md
1010
docs/ActiveObjectIdentification.md
11+
docs/AdHocAutomation.md
1112
docs/AfmExecution.md
1213
docs/AfmExecutionResponse.md
1314
docs/AfmIdentifier.md
@@ -878,6 +879,7 @@ docs/TotalDimension.md
878879
docs/TotalExecutionResultHeader.md
879880
docs/TotalResultHeader.md
880881
docs/TranslationsApi.md
882+
docs/TriggerAutomationRequest.md
881883
docs/UnsubscribeApi.md
882884
docs/UsageApi.md
883885
docs/UserAssignee.md
@@ -1007,6 +1009,7 @@ gooddata_api_client/model/absolute_date_filter.py
10071009
gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py
10081010
gooddata_api_client/model/abstract_measure_value_filter.py
10091011
gooddata_api_client/model/active_object_identification.py
1012+
gooddata_api_client/model/ad_hoc_automation.py
10101013
gooddata_api_client/model/afm.py
10111014
gooddata_api_client/model/afm_execution.py
10121015
gooddata_api_client/model/afm_execution_response.py
@@ -1829,6 +1832,7 @@ gooddata_api_client/model/total.py
18291832
gooddata_api_client/model/total_dimension.py
18301833
gooddata_api_client/model/total_execution_result_header.py
18311834
gooddata_api_client/model/total_result_header.py
1835+
gooddata_api_client/model/trigger_automation_request.py
18321836
gooddata_api_client/model/user_assignee.py
18331837
gooddata_api_client/model/user_context.py
18341838
gooddata_api_client/model/user_group_assignee.py

‎gooddata-api-client/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ Class | Method | HTTP request | Description
112112
*AutomationsApi* | [**get_entity_automations**](docs/AutomationsApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation
113113
*AutomationsApi* | [**patch_entity_automations**](docs/AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation
114114
*AutomationsApi* | [**set_automations**](docs/AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations
115+
*AutomationsApi* | [**trigger_automation**](docs/AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
116+
*AutomationsApi* | [**trigger_existing_automation**](docs/AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
115117
*AutomationsApi* | [**update_entity_automations**](docs/AutomationsApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation
116118
*AvailableDriversApi* | [**get_data_source_drivers**](docs/AvailableDriversApi.md#get_data_source_drivers) | **GET** /api/v1/options/availableDrivers | Get all available data source drivers
117119
*CSPDirectivesApi* | [**create_entity_csp_directives**](docs/CSPDirectivesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives
@@ -244,6 +246,9 @@ Class | Method | HTTP request | Description
244246
*NotificationChannelsApi* | [**get_all_entities_notification_channels**](docs/NotificationChannelsApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities
245247
*NotificationChannelsApi* | [**get_entity_notification_channels**](docs/NotificationChannelsApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity
246248
*NotificationChannelsApi* | [**get_notification_channels_layout**](docs/NotificationChannelsApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout
249+
*NotificationChannelsApi* | [**get_notifications**](docs/NotificationChannelsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications.
250+
*NotificationChannelsApi* | [**mark_as_read_notification**](docs/NotificationChannelsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read.
251+
*NotificationChannelsApi* | [**mark_as_read_notification_all**](docs/NotificationChannelsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read.
247252
*NotificationChannelsApi* | [**patch_entity_notification_channels**](docs/NotificationChannelsApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity
248253
*NotificationChannelsApi* | [**set_notification_channels**](docs/NotificationChannelsApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels
249254
*NotificationChannelsApi* | [**test_existing_notification_channel**](docs/NotificationChannelsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
@@ -457,6 +462,8 @@ Class | Method | HTTP request | Description
457462
*ActionsApi* | [**test_data_source_definition**](docs/ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
458463
*ActionsApi* | [**test_existing_notification_channel**](docs/ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
459464
*ActionsApi* | [**test_notification_channel**](docs/ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel.
465+
*ActionsApi* | [**trigger_automation**](docs/ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
466+
*ActionsApi* | [**trigger_existing_automation**](docs/ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
460467
*ActionsApi* | [**unsubscribe_all_automations**](docs/ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces
461468
*ActionsApi* | [**unsubscribe_automation**](docs/ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation
462469
*ActionsApi* | [**unsubscribe_workspace_automations**](docs/ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace
@@ -884,6 +891,7 @@ Class | Method | HTTP request | Description
884891
- [AbsoluteDateFilterAbsoluteDateFilter](docs/AbsoluteDateFilterAbsoluteDateFilter.md)
885892
- [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md)
886893
- [ActiveObjectIdentification](docs/ActiveObjectIdentification.md)
894+
- [AdHocAutomation](docs/AdHocAutomation.md)
887895
- [AfmExecution](docs/AfmExecution.md)
888896
- [AfmExecutionResponse](docs/AfmExecutionResponse.md)
889897
- [AfmIdentifier](docs/AfmIdentifier.md)
@@ -1705,6 +1713,7 @@ Class | Method | HTTP request | Description
17051713
- [TotalDimension](docs/TotalDimension.md)
17061714
- [TotalExecutionResultHeader](docs/TotalExecutionResultHeader.md)
17071715
- [TotalResultHeader](docs/TotalResultHeader.md)
1716+
- [TriggerAutomationRequest](docs/TriggerAutomationRequest.md)
17081717
- [UserAssignee](docs/UserAssignee.md)
17091718
- [UserContext](docs/UserContext.md)
17101719
- [UserGroupAssignee](docs/UserGroupAssignee.md)

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

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ Method | HTTP request | Description
7373
[**test_data_source_definition**](ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
7474
[**test_existing_notification_channel**](ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
7575
[**test_notification_channel**](ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel.
76+
[**trigger_automation**](ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
77+
[**trigger_existing_automation**](ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
7678
[**unsubscribe_all_automations**](ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces
7779
[**unsubscribe_automation**](ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation
7880
[**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace
@@ -1741,6 +1743,9 @@ with gooddata_api_client.ApiClient() as api_client:
17411743
),
17421744
],
17431745
),
1746+
execution_settings=ExecutionSettings(
1747+
data_sampling_percentage=0,
1748+
),
17441749
file_name="result",
17451750
format="CSV",
17461751
) # RawExportRequest |
@@ -5552,6 +5557,225 @@ No authorization required
55525557

55535558
[[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)
55545559

5560+
# **trigger_automation**
5561+
> trigger_automation(workspace_id, trigger_automation_request)
5562+
5563+
Trigger automation.
5564+
5565+
Trigger the automation in the request.
5566+
5567+
### Example
5568+
5569+
5570+
```python
5571+
import time
5572+
import gooddata_api_client
5573+
from gooddata_api_client.api import actions_api
5574+
from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest
5575+
from pprint import pprint
5576+
# Defining the host is optional and defaults to http://localhost
5577+
# See configuration.py for a list of all supported configuration parameters.
5578+
configuration = gooddata_api_client.Configuration(
5579+
host = "http://localhost"
5580+
)
5581+
5582+
5583+
# Enter a context with an instance of the API client
5584+
with gooddata_api_client.ApiClient() as api_client:
5585+
# Create an instance of the API class
5586+
api_instance = actions_api.ActionsApi(api_client)
5587+
workspace_id = "workspaceId_example" # str |
5588+
trigger_automation_request = TriggerAutomationRequest(
5589+
automation=AdHocAutomation(
5590+
analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier(
5591+
id="dashboard123",
5592+
type="analyticalDashboard",
5593+
),
5594+
description="description_example",
5595+
details={
5596+
"key": "key_example",
5597+
},
5598+
external_recipients=[
5599+
AutomationExternalRecipient(
5600+
email="email_example",
5601+
),
5602+
],
5603+
metadata=JsonNode(),
5604+
notification_channel=DeclarativeNotificationChannelIdentifier(
5605+
id="webhook123",
5606+
type="notificationChannel",
5607+
),
5608+
recipients=[
5609+
DeclarativeUserIdentifier(
5610+
id="employee123",
5611+
type="user",
5612+
),
5613+
],
5614+
tabular_exports=[
5615+
AutomationTabularExport(
5616+
request_payload=TabularExportRequest(
5617+
custom_override=CustomOverride(
5618+
labels={
5619+
"key": CustomLabel(
5620+
title="title_example",
5621+
),
5622+
},
5623+
metrics={
5624+
"key": CustomMetric(
5625+
format="format_example",
5626+
title="title_example",
5627+
),
5628+
},
5629+
),
5630+
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
5631+
file_name="result",
5632+
format="CSV",
5633+
metadata=JsonNode(),
5634+
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
5635+
settings=Settings(
5636+
merge_headers=True,
5637+
pdf_page_size="a4 landscape",
5638+
pdf_table_style=[
5639+
PdfTableStyle(
5640+
properties=[
5641+
PdfTableStyleProperty(
5642+
key="key_example",
5643+
value="value_example",
5644+
),
5645+
],
5646+
selector="selector_example",
5647+
),
5648+
],
5649+
pdf_top_left_content="Good",
5650+
pdf_top_right_content="Morning",
5651+
show_filters=False,
5652+
),
5653+
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
5654+
visualization_object_custom_filters=[
5655+
{},
5656+
],
5657+
),
5658+
),
5659+
],
5660+
tags=["Revenue","Sales"],
5661+
title="title_example",
5662+
visual_exports=[
5663+
AutomationVisualExport(
5664+
request_payload=VisualExportRequest(
5665+
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
5666+
file_name="filename",
5667+
metadata={},
5668+
),
5669+
),
5670+
],
5671+
),
5672+
) # TriggerAutomationRequest |
5673+
5674+
# example passing only required values which don't have defaults set
5675+
try:
5676+
# Trigger automation.
5677+
api_instance.trigger_automation(workspace_id, trigger_automation_request)
5678+
except gooddata_api_client.ApiException as e:
5679+
print("Exception when calling ActionsApi->trigger_automation: %s\n" % e)
5680+
```
5681+
5682+
5683+
### Parameters
5684+
5685+
Name | Type | Description | Notes
5686+
------------- | ------------- | ------------- | -------------
5687+
**workspace_id** | **str**| |
5688+
**trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| |
5689+
5690+
### Return type
5691+
5692+
void (empty response body)
5693+
5694+
### Authorization
5695+
5696+
No authorization required
5697+
5698+
### HTTP request headers
5699+
5700+
- **Content-Type**: application/json
5701+
- **Accept**: Not defined
5702+
5703+
5704+
### HTTP response details
5705+
5706+
| Status code | Description | Response headers |
5707+
|-------------|-------------|------------------|
5708+
**204** | The automation is successfully triggered. | - |
5709+
5710+
[[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)
5711+
5712+
# **trigger_existing_automation**
5713+
> trigger_existing_automation(workspace_id, automation_id)
5714+
5715+
Trigger existing automation.
5716+
5717+
Trigger the existing automation to execute immediately.
5718+
5719+
### Example
5720+
5721+
5722+
```python
5723+
import time
5724+
import gooddata_api_client
5725+
from gooddata_api_client.api import actions_api
5726+
from pprint import pprint
5727+
# Defining the host is optional and defaults to http://localhost
5728+
# See configuration.py for a list of all supported configuration parameters.
5729+
configuration = gooddata_api_client.Configuration(
5730+
host = "http://localhost"
5731+
)
5732+
5733+
5734+
# Enter a context with an instance of the API client
5735+
with gooddata_api_client.ApiClient() as api_client:
5736+
# Create an instance of the API class
5737+
api_instance = actions_api.ActionsApi(api_client)
5738+
workspace_id = "workspaceId_example" # str |
5739+
automation_id = "automationId_example" # str |
5740+
5741+
# example passing only required values which don't have defaults set
5742+
try:
5743+
# Trigger existing automation.
5744+
api_instance.trigger_existing_automation(workspace_id, automation_id)
5745+
except gooddata_api_client.ApiException as e:
5746+
print("Exception when calling ActionsApi->trigger_existing_automation: %s\n" % e)
5747+
```
5748+
5749+
5750+
### Parameters
5751+
5752+
Name | Type | Description | Notes
5753+
------------- | ------------- | ------------- | -------------
5754+
**workspace_id** | **str**| |
5755+
**automation_id** | **str**| |
5756+
5757+
### Return type
5758+
5759+
void (empty response body)
5760+
5761+
### Authorization
5762+
5763+
No authorization required
5764+
5765+
### HTTP request headers
5766+
5767+
- **Content-Type**: Not defined
5768+
- **Accept**: Not defined
5769+
5770+
5771+
### HTTP response details
5772+
5773+
| Status code | Description | Response headers |
5774+
|-------------|-------------|------------------|
5775+
**204** | The automation is successfully triggered. | - |
5776+
5777+
[[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)
5778+
55555779
# **unsubscribe_all_automations**
55565780
> unsubscribe_all_automations()
55575781

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AdHocAutomation
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional]
8+
**description** | **str** | | [optional]
9+
**details** | **{str: (str,)}** | Additional details to be included in the automated message. | [optional]
10+
**external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional]
11+
**metadata** | [**JsonNode**](JsonNode.md) | | [optional]
12+
**notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional]
13+
**recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional]
14+
**tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional]
15+
**tags** | **[str]** | A list of tags. | [optional]
16+
**title** | **str** | | [optional]
17+
**visual_exports** | [**[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional]
18+
**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]
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+

0 commit comments

Comments
 (0)