Skip to content

chore: re-generate client #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
no23reason merged 1 commit into from
Mar 18, 2025
Merged

chore: re-generate client #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions gooddata-api-client/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ docs/AbsoluteDateFilterAbsoluteDateFilter.md
docs/AbstractMeasureValueFilter.md
docs/ActionsApi.md
docs/ActiveObjectIdentification.md
docs/AdHocAutomation.md
docs/AfmExecution.md
docs/AfmExecutionResponse.md
docs/AfmIdentifier.md
Expand Down Expand Up @@ -878,6 +879,7 @@ docs/TotalDimension.md
docs/TotalExecutionResultHeader.md
docs/TotalResultHeader.md
docs/TranslationsApi.md
docs/TriggerAutomationRequest.md
docs/UnsubscribeApi.md
docs/UsageApi.md
docs/UserAssignee.md
Expand Down Expand Up @@ -1007,6 +1009,7 @@ gooddata_api_client/model/absolute_date_filter.py
gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py
gooddata_api_client/model/abstract_measure_value_filter.py
gooddata_api_client/model/active_object_identification.py
gooddata_api_client/model/ad_hoc_automation.py
gooddata_api_client/model/afm.py
gooddata_api_client/model/afm_execution.py
gooddata_api_client/model/afm_execution_response.py
Expand Down Expand Up @@ -1829,6 +1832,7 @@ gooddata_api_client/model/total.py
gooddata_api_client/model/total_dimension.py
gooddata_api_client/model/total_execution_result_header.py
gooddata_api_client/model/total_result_header.py
gooddata_api_client/model/trigger_automation_request.py
gooddata_api_client/model/user_assignee.py
gooddata_api_client/model/user_context.py
gooddata_api_client/model/user_group_assignee.py
Expand Down
9 changes: 9 additions & 0 deletions gooddata-api-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ Class | Method | HTTP request | Description
*AutomationsApi* | [**get_entity_automations**](docs/AutomationsApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation
*AutomationsApi* | [**patch_entity_automations**](docs/AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation
*AutomationsApi* | [**set_automations**](docs/AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations
*AutomationsApi* | [**trigger_automation**](docs/AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
*AutomationsApi* | [**trigger_existing_automation**](docs/AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
*AutomationsApi* | [**update_entity_automations**](docs/AutomationsApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation
*AvailableDriversApi* | [**get_data_source_drivers**](docs/AvailableDriversApi.md#get_data_source_drivers) | **GET** /api/v1/options/availableDrivers | Get all available data source drivers
*CSPDirectivesApi* | [**create_entity_csp_directives**](docs/CSPDirectivesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives
Expand Down Expand Up @@ -244,6 +246,9 @@ Class | Method | HTTP request | Description
*NotificationChannelsApi* | [**get_all_entities_notification_channels**](docs/NotificationChannelsApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities
*NotificationChannelsApi* | [**get_entity_notification_channels**](docs/NotificationChannelsApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity
*NotificationChannelsApi* | [**get_notification_channels_layout**](docs/NotificationChannelsApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout
*NotificationChannelsApi* | [**get_notifications**](docs/NotificationChannelsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications.
*NotificationChannelsApi* | [**mark_as_read_notification**](docs/NotificationChannelsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read.
*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.
*NotificationChannelsApi* | [**patch_entity_notification_channels**](docs/NotificationChannelsApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity
*NotificationChannelsApi* | [**set_notification_channels**](docs/NotificationChannelsApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels
*NotificationChannelsApi* | [**test_existing_notification_channel**](docs/NotificationChannelsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
Expand Down Expand Up @@ -457,6 +462,8 @@ Class | Method | HTTP request | Description
*ActionsApi* | [**test_data_source_definition**](docs/ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
*ActionsApi* | [**test_existing_notification_channel**](docs/ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
*ActionsApi* | [**test_notification_channel**](docs/ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel.
*ActionsApi* | [**trigger_automation**](docs/ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
*ActionsApi* | [**trigger_existing_automation**](docs/ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
*ActionsApi* | [**unsubscribe_all_automations**](docs/ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces
*ActionsApi* | [**unsubscribe_automation**](docs/ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation
*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
Expand Down Expand Up @@ -884,6 +891,7 @@ Class | Method | HTTP request | Description
- [AbsoluteDateFilterAbsoluteDateFilter](docs/AbsoluteDateFilterAbsoluteDateFilter.md)
- [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md)
- [ActiveObjectIdentification](docs/ActiveObjectIdentification.md)
- [AdHocAutomation](docs/AdHocAutomation.md)
- [AfmExecution](docs/AfmExecution.md)
- [AfmExecutionResponse](docs/AfmExecutionResponse.md)
- [AfmIdentifier](docs/AfmIdentifier.md)
Expand Down Expand Up @@ -1705,6 +1713,7 @@ Class | Method | HTTP request | Description
- [TotalDimension](docs/TotalDimension.md)
- [TotalExecutionResultHeader](docs/TotalExecutionResultHeader.md)
- [TotalResultHeader](docs/TotalResultHeader.md)
- [TriggerAutomationRequest](docs/TriggerAutomationRequest.md)
- [UserAssignee](docs/UserAssignee.md)
- [UserContext](docs/UserContext.md)
- [UserGroupAssignee](docs/UserGroupAssignee.md)
Expand Down
224 changes: 224 additions & 0 deletions gooddata-api-client/docs/ActionsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ Method | HTTP request | Description
[**test_data_source_definition**](ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
[**test_existing_notification_channel**](ActionsApi.md#test_existing_notification_channel) | **POST** /api/v1/actions/notificationChannels/{notificationChannelId}/test | Test existing notification channel.
[**test_notification_channel**](ActionsApi.md#test_notification_channel) | **POST** /api/v1/actions/notificationChannels/test | Test notification channel.
[**trigger_automation**](ActionsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation.
[**trigger_existing_automation**](ActionsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation.
[**unsubscribe_all_automations**](ActionsApi.md#unsubscribe_all_automations) | **DELETE** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from all automations in all workspaces
[**unsubscribe_automation**](ActionsApi.md#unsubscribe_automation) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe | Unsubscribe from an automation
[**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace
Expand Down Expand Up @@ -1741,6 +1743,9 @@ with gooddata_api_client.ApiClient() as api_client:
),
],
),
execution_settings=ExecutionSettings(
data_sampling_percentage=0,
),
file_name="result",
format="CSV",
) # RawExportRequest |
Expand Down Expand Up @@ -5552,6 +5557,225 @@ No authorization required

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

# **trigger_automation**
> trigger_automation(workspace_id, trigger_automation_request)

Trigger automation.

Trigger the automation in the request.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import actions_api
from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = actions_api.ActionsApi(api_client)
workspace_id = "workspaceId_example" # str |
trigger_automation_request = TriggerAutomationRequest(
automation=AdHocAutomation(
analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier(
id="dashboard123",
type="analyticalDashboard",
),
description="description_example",
details={
"key": "key_example",
},
external_recipients=[
AutomationExternalRecipient(
email="email_example",
),
],
metadata=JsonNode(),
notification_channel=DeclarativeNotificationChannelIdentifier(
id="webhook123",
type="notificationChannel",
),
recipients=[
DeclarativeUserIdentifier(
id="employee123",
type="user",
),
],
tabular_exports=[
AutomationTabularExport(
request_payload=TabularExportRequest(
custom_override=CustomOverride(
labels={
"key": CustomLabel(
title="title_example",
),
},
metrics={
"key": CustomMetric(
format="format_example",
title="title_example",
),
},
),
execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4",
file_name="result",
format="CSV",
metadata=JsonNode(),
related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
settings=Settings(
merge_headers=True,
pdf_page_size="a4 landscape",
pdf_table_style=[
PdfTableStyle(
properties=[
PdfTableStyleProperty(
key="key_example",
value="value_example",
),
],
selector="selector_example",
),
],
pdf_top_left_content="Good",
pdf_top_right_content="Morning",
show_filters=False,
),
visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537",
visualization_object_custom_filters=[
{},
],
),
),
],
tags=["Revenue","Sales"],
title="title_example",
visual_exports=[
AutomationVisualExport(
request_payload=VisualExportRequest(
dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
file_name="filename",
metadata={},
),
),
],
),
) # TriggerAutomationRequest |

# example passing only required values which don't have defaults set
try:
# Trigger automation.
api_instance.trigger_automation(workspace_id, trigger_automation_request)
except gooddata_api_client.ApiException as e:
print("Exception when calling ActionsApi->trigger_automation: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**workspace_id** | **str**| |
**trigger_automation_request** | [**TriggerAutomationRequest**](TriggerAutomationRequest.md)| |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The automation is successfully triggered. | - |

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

# **trigger_existing_automation**
> trigger_existing_automation(workspace_id, automation_id)

Trigger existing automation.

Trigger the existing automation to execute immediately.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import actions_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = actions_api.ActionsApi(api_client)
workspace_id = "workspaceId_example" # str |
automation_id = "automationId_example" # str |

# example passing only required values which don't have defaults set
try:
# Trigger existing automation.
api_instance.trigger_existing_automation(workspace_id, automation_id)
except gooddata_api_client.ApiException as e:
print("Exception when calling ActionsApi->trigger_existing_automation: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**workspace_id** | **str**| |
**automation_id** | **str**| |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The automation is successfully triggered. | - |

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

# **unsubscribe_all_automations**
> unsubscribe_all_automations()

Expand Down
22 changes: 22 additions & 0 deletions gooddata-api-client/docs/AdHocAutomation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# AdHocAutomation


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional]
**description** | **str** | | [optional]
**details** | **{str: (str,)}** | Additional details to be included in the automated message. | [optional]
**external_recipients** | [**[AutomationExternalRecipient]**](AutomationExternalRecipient.md) | External recipients of the automation action results. | [optional]
**metadata** | [**JsonNode**](JsonNode.md) | | [optional]
**notification_channel** | [**DeclarativeNotificationChannelIdentifier**](DeclarativeNotificationChannelIdentifier.md) | | [optional]
**recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional]
**tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional]
**tags** | **[str]** | A list of tags. | [optional]
**title** | **str** | | [optional]
**visual_exports** | [**[AutomationVisualExport]**](AutomationVisualExport.md) | | [optional]
**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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading