From 3197346909c0e8e93435129f49ff8fa3086fe015 Mon Sep 17 00:00:00 2001 From: Jan Kadlec Date: Wed, 23 Oct 2024 13:49:57 +0200 Subject: [PATCH] fix: regenerate API client and fix automations There was an issue with DeclarativeNotificationChannel. It was fixed on backend and it needed to be propagated to PySDK. Also, there were some issues with Automation entity that were fixed. JIRA: TRIVIAL risk: low --- gooddata-api-client/.openapi-generator/FILES | 16 + gooddata-api-client/README.md | 12 + gooddata-api-client/docs/ActionsApi.md | 19 +- gooddata-api-client/docs/AlertAfm.md | 2 + .../docs/AutomationTabularExport.md | 12 + .../docs/AutomationVisualExport.md | 12 + gooddata-api-client/docs/AutomationsApi.md | 278 +++++++++ .../docs/ChatHistoryInteraction.md | 4 +- .../docs/ChatHistoryRequest.md | 2 +- gooddata-api-client/docs/ChatRequest.md | 2 +- gooddata-api-client/docs/ChatResult.md | 2 +- gooddata-api-client/docs/ColumnOverride.md | 16 + ...eclarativeAnalyticalDashboardIdentifier.md | 14 + .../docs/DeclarativeAutomation.md | 3 + .../docs/DeclarativeFilterView.md | 19 + .../docs/DeclarativeNotificationChannel.md | 2 +- .../docs/DeclarativeOrganizationInfo.md | 1 + .../docs/DeclarativeWorkspace.md | 1 + gooddata-api-client/docs/DimAttribute.md | 1 + gooddata-api-client/docs/EntitiesApi.md | 225 ++++++++ gooddata-api-client/docs/FilterViewsApi.md | 169 ++++++ .../docs/GenerateLdmRequest.md | 4 +- .../docs/GenerateLogicalDataModelApi.md | 15 +- .../docs/JsonApiAutomationInAttributes.md | 2 + ...tomationInAttributesTabularExportsInner.md | 12 + ...utomationInAttributesVisualExportsInner.md | 12 + .../docs/JsonApiAutomationOutAttributes.md | 2 + .../docs/JsonApiOrganizationInAttributes.md | 1 + .../docs/JsonApiOrganizationOutAttributes.md | 1 + gooddata-api-client/docs/LayoutApi.md | 393 ++++++++++++- gooddata-api-client/docs/Metric.md | 1 + .../docs/OrganizationControllerApi.md | 6 + .../docs/OrganizationDeclarativeAPIsApi.md | 84 ++- .../docs/OrganizationEntityAPIsApi.md | 6 + gooddata-api-client/docs/PdmLdmRequest.md | 1 + gooddata-api-client/docs/SmartFunctionsApi.md | 4 +- gooddata-api-client/docs/TableOverride.md | 14 + .../docs/WorkspaceObjectControllerApi.md | 219 ++++++++ .../docs/WorkspacesDeclarativeAPIsApi.md | 79 +++ .../api/filter_views_api.py | 286 ++++++++++ .../gooddata_api_client/api/layout_api.py | 286 ++++++++++ .../gooddata_api_client/model/alert_afm.py | 12 + .../model/automation_tabular_export.py | 276 +++++++++ .../model/automation_visual_export.py | 276 +++++++++ .../model/chat_history_interaction.py | 26 +- .../model/chat_history_request.py | 8 +- .../gooddata_api_client/model/chat_request.py | 8 +- .../gooddata_api_client/model/chat_result.py | 8 +- .../model/column_override.py | 294 ++++++++++ ...arative_analytical_dashboard_identifier.py | 286 ++++++++++ .../model/declarative_automation.py | 22 + .../model/declarative_filter_view.py | 323 +++++++++++ .../model/declarative_notification_channel.py | 12 +- .../model/declarative_organization_info.py | 6 + .../model/declarative_setting.py | 1 + .../model/declarative_workspace.py | 6 + .../model/dim_attribute.py | 10 +- .../model/generate_ldm_request.py | 8 +- .../json_api_automation_in_attributes.py | 12 + ...ion_in_attributes_tabular_exports_inner.py | 276 +++++++++ ...tion_in_attributes_visual_exports_inner.py | 276 +++++++++ .../json_api_automation_out_attributes.py | 12 + .../json_api_organization_in_attributes.py | 6 + .../json_api_organization_out_attributes.py | 6 + ..._api_organization_setting_in_attributes.py | 1 + .../gooddata_api_client/model/metric.py | 10 +- .../model/pdm_ldm_request.py | 6 + .../model/resolved_setting.py | 1 + .../model/table_override.py | 282 ++++++++++ .../gooddata_api_client/models/__init__.py | 8 + gooddata-sdk/gooddata_sdk/__init__.py | 1 + .../gooddata_sdk/catalog/export/request.py | 37 +- .../layout/notification_channel.py | 4 +- .../declarative_model/workspace/automation.py | 34 +- .../gooddata_sdk/catalog/workspace/service.py | 2 +- .../layout_notification_channels.yaml | 19 +- .../workspaces/layout_automations.yaml | 26 +- .../catalog/test_catalog_organization.py | 14 +- .../tests/catalog/test_catalog_workspace.py | 5 + schemas/gooddata-afm-client.json | 53 +- schemas/gooddata-api-client.json | 527 ++++++++++++++++-- schemas/gooddata-metadata-client.json | 505 ++++++++++++++++- 82 files changed, 5774 insertions(+), 171 deletions(-) create mode 100644 gooddata-api-client/docs/AutomationTabularExport.md create mode 100644 gooddata-api-client/docs/AutomationVisualExport.md create mode 100644 gooddata-api-client/docs/ColumnOverride.md create mode 100644 gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md create mode 100644 gooddata-api-client/docs/DeclarativeFilterView.md create mode 100644 gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md create mode 100644 gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md create mode 100644 gooddata-api-client/docs/TableOverride.md create mode 100644 gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py create mode 100644 gooddata-api-client/gooddata_api_client/model/automation_visual_export.py create mode 100644 gooddata-api-client/gooddata_api_client/model/column_override.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py create mode 100644 gooddata-api-client/gooddata_api_client/model/table_override.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 6a1090364..a7c06ef6a 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -50,6 +50,8 @@ docs/AttributeItem.md docs/AttributeResultHeader.md docs/AttributesApi.md docs/AutomationSchedule.md +docs/AutomationTabularExport.md +docs/AutomationVisualExport.md docs/AutomationsApi.md docs/AvailableAssignees.md docs/AvailableDriversApi.md @@ -62,6 +64,7 @@ docs/ChatResult.md docs/ClusteringRequest.md docs/ClusteringResult.md docs/ColumnLocation.md +docs/ColumnOverride.md docs/ColumnStatistic.md docs/ColumnStatisticWarning.md docs/ColumnStatisticsRequest.md @@ -99,6 +102,7 @@ docs/DatasetsApi.md docs/DateFilter.md docs/DeclarativeAnalyticalDashboard.md docs/DeclarativeAnalyticalDashboardExtension.md +docs/DeclarativeAnalyticalDashboardIdentifier.md docs/DeclarativeAnalyticalDashboardPermissionAssignment.md docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md @@ -128,6 +132,7 @@ docs/DeclarativeExportDefinitionIdentifier.md docs/DeclarativeExportDefinitionRequestPayload.md docs/DeclarativeFact.md docs/DeclarativeFilterContext.md +docs/DeclarativeFilterView.md docs/DeclarativeJwk.md docs/DeclarativeJwkSpecification.md docs/DeclarativeLabel.md @@ -307,6 +312,8 @@ docs/JsonApiAutomationIn.md docs/JsonApiAutomationInAttributes.md docs/JsonApiAutomationInAttributesAlert.md docs/JsonApiAutomationInAttributesSchedule.md +docs/JsonApiAutomationInAttributesTabularExportsInner.md +docs/JsonApiAutomationInAttributesVisualExportsInner.md docs/JsonApiAutomationInDocument.md docs/JsonApiAutomationInRelationships.md docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md @@ -817,6 +824,7 @@ docs/SqlQuery.md docs/SqlQueryAllOf.md docs/Table.md docs/TableAllOf.md +docs/TableOverride.md docs/TableWarning.md docs/TabularExportApi.md docs/TabularExportRequest.md @@ -991,6 +999,8 @@ gooddata_api_client/model/attribute_header_out_attribute_header.py gooddata_api_client/model/attribute_item.py gooddata_api_client/model/attribute_result_header.py gooddata_api_client/model/automation_schedule.py +gooddata_api_client/model/automation_tabular_export.py +gooddata_api_client/model/automation_visual_export.py gooddata_api_client/model/available_assignees.py gooddata_api_client/model/chat_history_interaction.py gooddata_api_client/model/chat_history_request.py @@ -1000,6 +1010,7 @@ gooddata_api_client/model/chat_result.py gooddata_api_client/model/clustering_request.py gooddata_api_client/model/clustering_result.py gooddata_api_client/model/column_location.py +gooddata_api_client/model/column_override.py gooddata_api_client/model/column_statistic.py gooddata_api_client/model/column_statistic_warning.py gooddata_api_client/model/column_statistics_request.py @@ -1029,6 +1040,7 @@ gooddata_api_client/model/dataset_workspace_data_filter_identifier.py gooddata_api_client/model/date_filter.py gooddata_api_client/model/declarative_analytical_dashboard.py gooddata_api_client/model/declarative_analytical_dashboard_extension.py +gooddata_api_client/model/declarative_analytical_dashboard_identifier.py gooddata_api_client/model/declarative_analytical_dashboard_permission_assignment.py gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee.py gooddata_api_client/model/declarative_analytical_dashboard_permission_for_assignee_all_of.py @@ -1058,6 +1070,7 @@ gooddata_api_client/model/declarative_export_definition_identifier.py gooddata_api_client/model/declarative_export_definition_request_payload.py gooddata_api_client/model/declarative_fact.py gooddata_api_client/model/declarative_filter_context.py +gooddata_api_client/model/declarative_filter_view.py gooddata_api_client/model/declarative_jwk.py gooddata_api_client/model/declarative_jwk_specification.py gooddata_api_client/model/declarative_label.py @@ -1226,6 +1239,8 @@ gooddata_api_client/model/json_api_automation_in.py gooddata_api_client/model/json_api_automation_in_attributes.py gooddata_api_client/model/json_api_automation_in_attributes_alert.py gooddata_api_client/model/json_api_automation_in_attributes_schedule.py +gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py +gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py gooddata_api_client/model/json_api_automation_in_document.py gooddata_api_client/model/json_api_automation_in_relationships.py gooddata_api_client/model/json_api_automation_in_relationships_analytical_dashboard.py @@ -1719,6 +1734,7 @@ gooddata_api_client/model/sql_query.py gooddata_api_client/model/sql_query_all_of.py gooddata_api_client/model/table.py gooddata_api_client/model/table_all_of.py +gooddata_api_client/model/table_override.py gooddata_api_client/model/table_warning.py gooddata_api_client/model/tabular_export_request.py gooddata_api_client/model/test_definition_request.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index d27e1fc84..4a7fccbfe 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -194,7 +194,9 @@ Class | Method | HTTP request | Description *FilterViewsApi* | [**delete_entity_filter_views**](docs/FilterViewsApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view *FilterViewsApi* | [**get_all_entities_filter_views**](docs/FilterViewsApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views *FilterViewsApi* | [**get_entity_filter_views**](docs/FilterViewsApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +*FilterViewsApi* | [**get_filter_views**](docs/FilterViewsApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views *FilterViewsApi* | [**patch_entity_filter_views**](docs/FilterViewsApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view +*FilterViewsApi* | [**set_filter_views**](docs/FilterViewsApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views *FilterViewsApi* | [**update_entity_filter_views**](docs/FilterViewsApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *GenerateLogicalDataModelApi* | [**generate_logical_model**](docs/GenerateLogicalDataModelApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) *HierarchyApi* | [**check_entity_overrides**](docs/HierarchyApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. @@ -626,6 +628,7 @@ Class | Method | HTTP request | Description *LayoutApi* | [**get_automations**](docs/LayoutApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations *LayoutApi* | [**get_data_source_permissions**](docs/LayoutApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source *LayoutApi* | [**get_data_sources_layout**](docs/LayoutApi.md#get_data_sources_layout) | **GET** /api/v1/layout/dataSources | Get all data sources +*LayoutApi* | [**get_filter_views**](docs/LayoutApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views *LayoutApi* | [**get_logical_model**](docs/LayoutApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model *LayoutApi* | [**get_notification_channels_layout**](docs/LayoutApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout *LayoutApi* | [**get_organization_layout**](docs/LayoutApi.md#get_organization_layout) | **GET** /api/v1/layout/organization | Get organization layout @@ -648,6 +651,7 @@ Class | Method | HTTP request | Description *LayoutApi* | [**set_analytics_model**](docs/LayoutApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model *LayoutApi* | [**set_automations**](docs/LayoutApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations *LayoutApi* | [**set_data_source_permissions**](docs/LayoutApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. +*LayoutApi* | [**set_filter_views**](docs/LayoutApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views *LayoutApi* | [**set_logical_model**](docs/LayoutApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model *LayoutApi* | [**set_notification_channels**](docs/LayoutApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels *LayoutApi* | [**set_organization_layout**](docs/LayoutApi.md#set_organization_layout) | **PUT** /api/v1/layout/organization | Set organization layout @@ -890,6 +894,8 @@ Class | Method | HTTP request | Description - [AttributeItem](docs/AttributeItem.md) - [AttributeResultHeader](docs/AttributeResultHeader.md) - [AutomationSchedule](docs/AutomationSchedule.md) + - [AutomationTabularExport](docs/AutomationTabularExport.md) + - [AutomationVisualExport](docs/AutomationVisualExport.md) - [AvailableAssignees](docs/AvailableAssignees.md) - [ChatHistoryInteraction](docs/ChatHistoryInteraction.md) - [ChatHistoryRequest](docs/ChatHistoryRequest.md) @@ -899,6 +905,7 @@ Class | Method | HTTP request | Description - [ClusteringRequest](docs/ClusteringRequest.md) - [ClusteringResult](docs/ClusteringResult.md) - [ColumnLocation](docs/ColumnLocation.md) + - [ColumnOverride](docs/ColumnOverride.md) - [ColumnStatistic](docs/ColumnStatistic.md) - [ColumnStatisticWarning](docs/ColumnStatisticWarning.md) - [ColumnStatisticsRequest](docs/ColumnStatisticsRequest.md) @@ -928,6 +935,7 @@ Class | Method | HTTP request | Description - [DateFilter](docs/DateFilter.md) - [DeclarativeAnalyticalDashboard](docs/DeclarativeAnalyticalDashboard.md) - [DeclarativeAnalyticalDashboardExtension](docs/DeclarativeAnalyticalDashboardExtension.md) + - [DeclarativeAnalyticalDashboardIdentifier](docs/DeclarativeAnalyticalDashboardIdentifier.md) - [DeclarativeAnalyticalDashboardPermissionAssignment](docs/DeclarativeAnalyticalDashboardPermissionAssignment.md) - [DeclarativeAnalyticalDashboardPermissionForAssignee](docs/DeclarativeAnalyticalDashboardPermissionForAssignee.md) - [DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf](docs/DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf.md) @@ -957,6 +965,7 @@ Class | Method | HTTP request | Description - [DeclarativeExportDefinitionRequestPayload](docs/DeclarativeExportDefinitionRequestPayload.md) - [DeclarativeFact](docs/DeclarativeFact.md) - [DeclarativeFilterContext](docs/DeclarativeFilterContext.md) + - [DeclarativeFilterView](docs/DeclarativeFilterView.md) - [DeclarativeJwk](docs/DeclarativeJwk.md) - [DeclarativeJwkSpecification](docs/DeclarativeJwkSpecification.md) - [DeclarativeLabel](docs/DeclarativeLabel.md) @@ -1125,6 +1134,8 @@ Class | Method | HTTP request | Description - [JsonApiAutomationInAttributes](docs/JsonApiAutomationInAttributes.md) - [JsonApiAutomationInAttributesAlert](docs/JsonApiAutomationInAttributesAlert.md) - [JsonApiAutomationInAttributesSchedule](docs/JsonApiAutomationInAttributesSchedule.md) + - [JsonApiAutomationInAttributesTabularExportsInner](docs/JsonApiAutomationInAttributesTabularExportsInner.md) + - [JsonApiAutomationInAttributesVisualExportsInner](docs/JsonApiAutomationInAttributesVisualExportsInner.md) - [JsonApiAutomationInDocument](docs/JsonApiAutomationInDocument.md) - [JsonApiAutomationInRelationships](docs/JsonApiAutomationInRelationships.md) - [JsonApiAutomationInRelationshipsAnalyticalDashboard](docs/JsonApiAutomationInRelationshipsAnalyticalDashboard.md) @@ -1618,6 +1629,7 @@ Class | Method | HTTP request | Description - [SqlQueryAllOf](docs/SqlQueryAllOf.md) - [Table](docs/Table.md) - [TableAllOf](docs/TableAllOf.md) + - [TableOverride](docs/TableOverride.md) - [TableWarning](docs/TableWarning.md) - [TabularExportRequest](docs/TabularExportRequest.md) - [TestDefinitionRequest](docs/TestDefinitionRequest.md) diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index 2782ebd16..087f6312d 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -99,13 +99,13 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier chat_request = ChatRequest( - chat_history_thread_id="chat_history_thread_id_example", limit_create=3, limit_create_context=10, limit_search=5, question="question_example", relevant_score_threshold=0.4, search_score_threshold=0.9, + thread_id_suffix="thread_id_suffix_example", title_to_descriptor_ratio=0.7, user_context=UserContext( active_object=ActiveObjectIdentification( @@ -186,8 +186,8 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier chat_history_request = ChatHistoryRequest( chat_history_interaction_id=1, - chat_history_thread_id="chat_history_thread_id_example", reset=True, + thread_id_suffix="thread_id_suffix_example", user_feedback="POSITIVE", ) # ChatHistoryRequest | @@ -2092,7 +2092,7 @@ with gooddata_api_client.ApiClient() as api_client: date_granularities="all", denorm_prefix="dr", fact_prefix="f", - generate_long_ids=True, + generate_long_ids=False, grain_multivalue_reference_prefix="grmr", grain_prefix="gr", grain_reference_prefix="grr", @@ -2110,6 +2110,19 @@ with gooddata_api_client.ApiClient() as api_client: title="My special dataset", ), ], + table_overrides=[ + TableOverride( + columns=[ + ColumnOverride( + label_target_column="users", + label_type="HYPERLINK", + ldm_type_override="FACT", + name="column_name", + ), + ], + path=["schema","table_name"], + ), + ], tables=[ DeclarativeTable( columns=[ diff --git a/gooddata-api-client/docs/AlertAfm.md b/gooddata-api-client/docs/AlertAfm.md index 3dc2e92a6..dfefad620 100644 --- a/gooddata-api-client/docs/AlertAfm.md +++ b/gooddata-api-client/docs/AlertAfm.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filters** | [**[FilterDefinition]**](FilterDefinition.md) | Various filter types to filter execution result. | **measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other. | +**attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | [optional] +**aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [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) diff --git a/gooddata-api-client/docs/AutomationTabularExport.md b/gooddata-api-client/docs/AutomationTabularExport.md new file mode 100644 index 000000000..970e2f2c4 --- /dev/null +++ b/gooddata-api-client/docs/AutomationTabularExport.md @@ -0,0 +1,12 @@ +# AutomationTabularExport + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_payload** | [**TabularExportRequest**](TabularExportRequest.md) | | +**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) + + diff --git a/gooddata-api-client/docs/AutomationVisualExport.md b/gooddata-api-client/docs/AutomationVisualExport.md new file mode 100644 index 000000000..718e20792 --- /dev/null +++ b/gooddata-api-client/docs/AutomationVisualExport.md @@ -0,0 +1,12 @@ +# AutomationVisualExport + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_payload** | [**VisualExportRequest**](VisualExportRequest.md) | | +**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) + + diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index aa9497791..ed2432107 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -47,6 +47,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -69,10 +87,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -532,6 +605,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -554,10 +645,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -673,6 +819,10 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | declarative_automation = [ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -711,10 +861,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ] # [DeclarativeAutomation] | @@ -790,6 +995,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -812,10 +1035,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( diff --git a/gooddata-api-client/docs/ChatHistoryInteraction.md b/gooddata-api-client/docs/ChatHistoryInteraction.md index 2b57c5038..f89a82cf5 100644 --- a/gooddata-api-client/docs/ChatHistoryInteraction.md +++ b/gooddata-api-client/docs/ChatHistoryInteraction.md @@ -5,14 +5,14 @@ List of chat history interactions. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**chat_history_interaction_id** | **int** | Chat History interaction ID. Unique ID for each interaction. | **interaction_finished** | **bool** | Has the interaction already finished? Can be used for polling when interaction is in progress. | -**interaction_id** | **int** | Chat History interaction ID. Unique ID for each interaction. | **question** | **str** | User question | **routing** | [**RouteResult**](RouteResult.md) | | -**thread_id** | **str** | Chat History thread ID. Backend persists chat history and returns ID for further requests. | **created_visualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] **found_objects** | [**FoundObjects**](FoundObjects.md) | | [optional] **text_response** | **str** | Text response for general questions. | [optional] +**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [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) diff --git a/gooddata-api-client/docs/ChatHistoryRequest.md b/gooddata-api-client/docs/ChatHistoryRequest.md index 418a487d8..fefcbdc9f 100644 --- a/gooddata-api-client/docs/ChatHistoryRequest.md +++ b/gooddata-api-client/docs/ChatHistoryRequest.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **chat_history_interaction_id** | **int** | Return chat history records only after this interaction ID. If empty, complete chat history is returned. | [optional] -**chat_history_thread_id** | **str** | Chat History thread ID. Optional, backend can create it if not provided. | [optional] **reset** | **bool** | User feedback. | [optional] +**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] **user_feedback** | **str** | User feedback. | [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] diff --git a/gooddata-api-client/docs/ChatRequest.md b/gooddata-api-client/docs/ChatRequest.md index 179ad2148..d8498d9fc 100644 --- a/gooddata-api-client/docs/ChatRequest.md +++ b/gooddata-api-client/docs/ChatRequest.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **question** | **str** | User question | -**chat_history_thread_id** | **str** | Chat History thread ID. Backend persists chat history and returns ID for further requests. | [optional] **limit_create** | **int** | Maximum number of created results. | [optional] if omitted the server will use the default value of 3 **limit_create_context** | **int** | Maximum number of relevant objects included into context for LLM (for each object type). | [optional] if omitted the server will use the default value of 10 **limit_search** | **int** | Maximum number of search results. | [optional] if omitted the server will use the default value of 5 **relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] if omitted the server will use the default value of 0.4 **search_score_threshold** | **float** | Score, above which we return found object(s) and don't call LLM to create new objects. | [optional] if omitted the server will use the default value of 0.9 +**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] **title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7 **user_context** | [**UserContext**](UserContext.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] diff --git a/gooddata-api-client/docs/ChatResult.md b/gooddata-api-client/docs/ChatResult.md index f1239ddab..52cf9e5db 100644 --- a/gooddata-api-client/docs/ChatResult.md +++ b/gooddata-api-client/docs/ChatResult.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **routing** | [**RouteResult**](RouteResult.md) | | -**chat_history_thread_id** | **str** | Chat History thread ID. Backend persists chat history and returns ID for further requests. | [optional] **created_visualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] **found_objects** | [**FoundObjects**](FoundObjects.md) | | [optional] **text_response** | **str** | Text response for general questions. | [optional] +**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [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) diff --git a/gooddata-api-client/docs/ColumnOverride.md b/gooddata-api-client/docs/ColumnOverride.md new file mode 100644 index 000000000..75ab9d6c6 --- /dev/null +++ b/gooddata-api-client/docs/ColumnOverride.md @@ -0,0 +1,16 @@ +# ColumnOverride + +Table column override. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Column name. | +**label_target_column** | **str** | Specifies the attribute's column to which this label is associated. | [optional] +**label_type** | **str** | Label type for the target attribute. | [optional] +**ldm_type_override** | **str** | Logical Data Model type for the column. | [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) + + diff --git a/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md new file mode 100644 index 000000000..2da17c9b5 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboardIdentifier.md @@ -0,0 +1,14 @@ +# DeclarativeAnalyticalDashboardIdentifier + +An analytical dashboard identifier. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of the analytical dashboard. | +**type** | **str** | A type. | defaults to "analyticalDashboard" +**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) + + diff --git a/gooddata-api-client/docs/DeclarativeAutomation.md b/gooddata-api-client/docs/DeclarativeAutomation.md index 11e47b224..eb84fdb7b 100644 --- a/gooddata-api-client/docs/DeclarativeAutomation.md +++ b/gooddata-api-client/docs/DeclarativeAutomation.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | +**analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] **created_at** | **str, none_type** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | | [optional] @@ -17,8 +18,10 @@ Name | Type | Description | Notes **recipients** | [**[DeclarativeUserIdentifier]**](DeclarativeUserIdentifier.md) | | [optional] **schedule** | [**AutomationSchedule**](AutomationSchedule.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] if omitted the server will use the default value of "ACTIVE" +**tabular_exports** | [**[AutomationTabularExport]**](AutomationTabularExport.md) | | [optional] **tags** | **[str]** | | [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) diff --git a/gooddata-api-client/docs/DeclarativeFilterView.md b/gooddata-api-client/docs/DeclarativeFilterView.md new file mode 100644 index 000000000..39d1163c1 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeFilterView.md @@ -0,0 +1,19 @@ +# DeclarativeFilterView + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | FilterView object ID. | +**title** | **str** | | +**analytical_dashboard** | [**DeclarativeAnalyticalDashboardIdentifier**](DeclarativeAnalyticalDashboardIdentifier.md) | | [optional] +**content** | [**JsonNode**](JsonNode.md) | | [optional] +**description** | **str** | | [optional] +**is_default** | **bool** | Indicator whether the filter view should by applied by default. | [optional] +**tags** | **[str]** | | [optional] +**user** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.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) + + diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannel.md b/gooddata-api-client/docs/DeclarativeNotificationChannel.md index dfc7fd4f4..ebac66343 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannel.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannel.md @@ -6,11 +6,11 @@ A declarative form of a particular notification channel. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Identifier of a notification channel | +**allowed_recipients** | **str** | Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization | [optional] if omitted the server will use the default value of "INTERNAL" **custom_dashboard_url** | **str** | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}. | [optional] **description** | **str** | Description of a notification channel. | [optional] **destination** | [**DeclarativeNotificationChannelDestination**](DeclarativeNotificationChannelDestination.md) | | [optional] **destination_type** | **str, none_type** | | [optional] [readonly] -**enable_multiple_recipients** | **bool** | Whether notifications sent to the channel can have multiple recipients. | [optional] if omitted the server will use the default value of True **name** | **str** | Name of a notification channel. | [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] diff --git a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md index f28fabc4e..f5f1ecc44 100644 --- a/gooddata-api-client/docs/DeclarativeOrganizationInfo.md +++ b/gooddata-api-client/docs/DeclarativeOrganizationInfo.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **jit_enabled** | **bool** | Flag to enable/disable JIT provisioning in the given organization | [optional] **oauth_client_id** | **str** | Identifier of the authentication provider | [optional] **oauth_client_secret** | **str** | Communication secret of the authentication provider (never returned back). | [optional] +**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | URI of the authentication provider. | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeWorkspace.md b/gooddata-api-client/docs/DeclarativeWorkspace.md index 6767474f1..91d84478c 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspace.md +++ b/gooddata-api-client/docs/DeclarativeWorkspace.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **description** | **str** | Description of the workspace | [optional] **early_access** | **str** | Early access defined on level Workspace | [optional] **early_access_values** | **[str]** | Early access defined on level Workspace | [optional] +**filter_views** | [**[DeclarativeFilterView]**](DeclarativeFilterView.md) | | [optional] **hierarchy_permissions** | [**[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] **model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md) | | [optional] **parent** | [**WorkspaceIdentifier**](WorkspaceIdentifier.md) | | [optional] diff --git a/gooddata-api-client/docs/DimAttribute.md b/gooddata-api-client/docs/DimAttribute.md index f6bf5bf6f..f080b11da 100644 --- a/gooddata-api-client/docs/DimAttribute.md +++ b/gooddata-api-client/docs/DimAttribute.md @@ -6,6 +6,7 @@ List of attributes representing the dimensionality of the new visualization Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of the object | +**title** | **str** | Title of attribute. | **type** | **str** | Object type | defaults to "attribute" **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] diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 353243ca8..0706289ff 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -498,6 +498,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -520,10 +538,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -11493,6 +11566,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -11515,10 +11606,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -13073,6 +13219,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", @@ -14279,6 +14428,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -14301,10 +14468,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -15859,6 +16081,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", diff --git a/gooddata-api-client/docs/FilterViewsApi.md b/gooddata-api-client/docs/FilterViewsApi.md index de7964544..5551ab7a2 100644 --- a/gooddata-api-client/docs/FilterViewsApi.md +++ b/gooddata-api-client/docs/FilterViewsApi.md @@ -8,7 +8,9 @@ Method | HTTP request | Description [**delete_entity_filter_views**](FilterViewsApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view [**get_all_entities_filter_views**](FilterViewsApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views [**get_entity_filter_views**](FilterViewsApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +[**get_filter_views**](FilterViewsApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views [**patch_entity_filter_views**](FilterViewsApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view +[**set_filter_views**](FilterViewsApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views [**update_entity_filter_views**](FilterViewsApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views @@ -371,6 +373,86 @@ 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) +# **get_filter_views** +> [DeclarativeFilterView] get_filter_views(workspace_id) + +Get filter views + +Retrieve filter views for the specific workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_views_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +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 = filter_views_api.FilterViewsApi(api_client) + workspace_id = "workspaceId_example" # str | + exclude = [ + "ACTIVITY_INFO", + ] # [str] | (optional) + + # example passing only required values which don't have defaults set + try: + # Get filter views + api_response = api_instance.get_filter_views(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get filter views + api_response = api_instance.get_filter_views(workspace_id, exclude=exclude) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->get_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **exclude** | **[str]**| | [optional] + +### Return type + +[**[DeclarativeFilterView]**](DeclarativeFilterView.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Retrieved filterViews. | - | + +[[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) + # **patch_entity_filter_views** > JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) @@ -479,6 +561,93 @@ 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) +# **set_filter_views** +> set_filter_views(workspace_id, declarative_filter_view) + +Set filter views + +Set filter views for the specific workspace. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import filter_views_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +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 = filter_views_api.FilterViewsApi(api_client) + workspace_id = "workspaceId_example" # str | + declarative_filter_view = [ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ] # [DeclarativeFilterView] | + + # example passing only required values which don't have defaults set + try: + # Set filter views + api_instance.set_filter_views(workspace_id, declarative_filter_view) + except gooddata_api_client.ApiException as e: + print("Exception when calling FilterViewsApi->set_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **declarative_filter_view** | [**[DeclarativeFilterView]**](DeclarativeFilterView.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** | FilterViews successfully set. | - | + +[[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) + # **update_entity_filter_views** > JsonApiFilterViewOutDocument update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document) diff --git a/gooddata-api-client/docs/GenerateLdmRequest.md b/gooddata-api-client/docs/GenerateLdmRequest.md index 79607386c..c36774341 100644 --- a/gooddata-api-client/docs/GenerateLdmRequest.md +++ b/gooddata-api-client/docs/GenerateLdmRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **date_granularities** | **str** | Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes). | [optional] **denorm_prefix** | **str** | Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references. | [optional] **fact_prefix** | **str** | Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts. | [optional] -**generate_long_ids** | **bool** | A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `<table>.<column>` is used. If the flag is set to true, then all ids will be generated in the long form. | [optional] +**generate_long_ids** | **bool** | A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `<table>.<column>` is used. If the flag is set to true, then all ids will be generated in the long form. | [optional] if omitted the server will use the default value of False **grain_multivalue_reference_prefix** | **str** | Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table. | [optional] **grain_prefix** | **str** | Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains. | [optional] **grain_reference_prefix** | **str** | Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table. | [optional] @@ -20,7 +20,7 @@ Name | Type | Description | Notes **separator** | **str** | A separator between prefixes and the names. Default is \"__\". | [optional] if omitted the server will use the default value of "__" **table_prefix** | **str** | Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned. | [optional] **view_prefix** | **str** | Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned. | [optional] -**wdf_prefix** | **str** | Column serving as workspace data filter. No labels are auto generated for such columns. | [optional] +**wdf_prefix** | **str** | Column serving as workspace data filter. No labels are auto generated for such columns. | [optional] if omitted the server will use the default value of "wdf" **workspace_id** | **str** | Optional workspace id. | [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] diff --git a/gooddata-api-client/docs/GenerateLogicalDataModelApi.md b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md index 822478918..394d1b5fb 100644 --- a/gooddata-api-client/docs/GenerateLogicalDataModelApi.md +++ b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md @@ -40,7 +40,7 @@ with gooddata_api_client.ApiClient() as api_client: date_granularities="all", denorm_prefix="dr", fact_prefix="f", - generate_long_ids=True, + generate_long_ids=False, grain_multivalue_reference_prefix="grmr", grain_prefix="gr", grain_reference_prefix="grr", @@ -58,6 +58,19 @@ with gooddata_api_client.ApiClient() as api_client: title="My special dataset", ), ], + table_overrides=[ + TableOverride( + columns=[ + ColumnOverride( + label_target_column="users", + label_type="HYPERLINK", + ldm_type_override="FACT", + name="column_name", + ), + ], + path=["schema","table_name"], + ), + ], tables=[ DeclarativeTable( columns=[ diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributes.md b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md index 70555f8c3..812590bb5 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributes.md @@ -11,8 +11,10 @@ Name | Type | Description | Notes **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Additional information for the automation. | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] +**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [optional] +**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.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) diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md new file mode 100644 index 000000000..c0ea782fa --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesTabularExportsInner.md @@ -0,0 +1,12 @@ +# JsonApiAutomationInAttributesTabularExportsInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_payload** | [**TabularExportRequest**](TabularExportRequest.md) | | +**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) + + diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md new file mode 100644 index 000000000..87a90a48b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesVisualExportsInner.md @@ -0,0 +1,12 @@ +# JsonApiAutomationInAttributesVisualExportsInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request_payload** | [**VisualExportRequest**](VisualExportRequest.md) | | +**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) + + diff --git a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md index 9334c35e3..bbfbd4d29 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md @@ -13,8 +13,10 @@ Name | Type | Description | Notes **modified_at** | **datetime** | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] **state** | **str** | Current state of the automation. | [optional] +**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [optional] +**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.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) diff --git a/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md index 7907c5aa7..98a6b053a 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationInAttributes.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **name** | **str, none_type** | | [optional] **oauth_client_id** | **str** | | [optional] **oauth_client_secret** | **str** | | [optional] +**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md index d123372ed..aee59e612 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutAttributes.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **jit_enabled** | **bool** | Flag to enable/disable JIT provisioning in the given organization | [optional] **name** | **str, none_type** | | [optional] **oauth_client_id** | **str** | | [optional] +**oauth_custom_auth_attributes** | **{str: (str,)}** | Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute. | [optional] **oauth_issuer_id** | **str** | Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. | [optional] **oauth_issuer_location** | **str** | | [optional] **oauth_subject_id_claim** | **str** | Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'. | [optional] diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index da8b674b8..0f212e9f2 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -8,6 +8,7 @@ Method | HTTP request | Description [**get_automations**](LayoutApi.md#get_automations) | **GET** /api/v1/layout/workspaces/{workspaceId}/automations | Get automations [**get_data_source_permissions**](LayoutApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source [**get_data_sources_layout**](LayoutApi.md#get_data_sources_layout) | **GET** /api/v1/layout/dataSources | Get all data sources +[**get_filter_views**](LayoutApi.md#get_filter_views) | **GET** /api/v1/layout/workspaces/{workspaceId}/filterViews | Get filter views [**get_logical_model**](LayoutApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model [**get_notification_channels_layout**](LayoutApi.md#get_notification_channels_layout) | **GET** /api/v1/layout/notificationChannels | Get all notification channels layout [**get_organization_layout**](LayoutApi.md#get_organization_layout) | **GET** /api/v1/layout/organization | Get organization layout @@ -30,6 +31,7 @@ Method | HTTP request | Description [**set_analytics_model**](LayoutApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model [**set_automations**](LayoutApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations [**set_data_source_permissions**](LayoutApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. +[**set_filter_views**](LayoutApi.md#set_filter_views) | **PUT** /api/v1/layout/workspaces/{workspaceId}/filterViews | Set filter views [**set_logical_model**](LayoutApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model [**set_notification_channels**](LayoutApi.md#set_notification_channels) | **PUT** /api/v1/layout/notificationChannels | Set all notification channels [**set_organization_layout**](LayoutApi.md#set_organization_layout) | **PUT** /api/v1/layout/organization | Set organization layout @@ -332,6 +334,86 @@ 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) +# **get_filter_views** +> [DeclarativeFilterView] get_filter_views(workspace_id) + +Get filter views + +Retrieve filter views for the specific workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import layout_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +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 = layout_api.LayoutApi(api_client) + workspace_id = "workspaceId_example" # str | + exclude = [ + "ACTIVITY_INFO", + ] # [str] | (optional) + + # example passing only required values which don't have defaults set + try: + # Get filter views + api_response = api_instance.get_filter_views(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LayoutApi->get_filter_views: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get filter views + api_response = api_instance.get_filter_views(workspace_id, exclude=exclude) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LayoutApi->get_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **exclude** | **[str]**| | [optional] + +### Return type + +[**[DeclarativeFilterView]**](DeclarativeFilterView.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Retrieved filterViews. | - | + +[[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) + # **get_logical_model** > DeclarativeModel get_logical_model(workspace_id) @@ -2256,6 +2338,10 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | declarative_automation = [ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -2294,10 +2380,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ] # [DeclarativeAutomation] | @@ -2417,6 +2558,93 @@ 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) +# **set_filter_views** +> set_filter_views(workspace_id, declarative_filter_view) + +Set filter views + +Set filter views for the specific workspace. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import layout_api +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView +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 = layout_api.LayoutApi(api_client) + workspace_id = "workspaceId_example" # str | + declarative_filter_view = [ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ] # [DeclarativeFilterView] | + + # example passing only required values which don't have defaults set + try: + # Set filter views + api_instance.set_filter_views(workspace_id, declarative_filter_view) + except gooddata_api_client.ApiException as e: + print("Exception when calling LayoutApi->set_filter_views: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **declarative_filter_view** | [**[DeclarativeFilterView]**](DeclarativeFilterView.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** | FilterViews successfully set. | - | + +[[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) + # **set_logical_model** > set_logical_model(workspace_id, declarative_model) @@ -2648,10 +2876,10 @@ with gooddata_api_client.ApiClient() as api_client: declarative_notification_channels = DeclarativeNotificationChannels( notification_channels=[ DeclarativeNotificationChannel( + allowed_recipients="INTERNAL", custom_dashboard_url="custom_dashboard_url_example", description="This is a channel", destination=DeclarativeNotificationChannelDestination(None), - enable_multiple_recipients=True, id="notification-channel-1", name="channel", ), @@ -2767,10 +2995,10 @@ with gooddata_api_client.ApiClient() as api_client: ], notification_channels=[ DeclarativeNotificationChannel( + allowed_recipients="INTERNAL", custom_dashboard_url="custom_dashboard_url_example", description="This is a channel", destination=DeclarativeNotificationChannelDestination(None), - enable_multiple_recipients=True, id="notification-channel-1", name="channel", ), @@ -2801,6 +3029,9 @@ with gooddata_api_client.ApiClient() as api_client: name="Alpha corporation", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", @@ -2908,6 +3139,10 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeWorkspace( automations=[ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -2946,10 +3181,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ], cache_extra_limit=1, @@ -2971,6 +3261,26 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + filter_views=[ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ], hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( @@ -3881,6 +4191,10 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeWorkspace( automations=[ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -3919,10 +4233,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ], cache_extra_limit=1, @@ -3944,6 +4313,26 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + filter_views=[ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ], hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( diff --git a/gooddata-api-client/docs/Metric.md b/gooddata-api-client/docs/Metric.md index 0cdeb463c..049008564 100644 --- a/gooddata-api-client/docs/Metric.md +++ b/gooddata-api-client/docs/Metric.md @@ -6,6 +6,7 @@ List of metrics to be used in the new visualization Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of the object | +**title** | **str** | Title of metric. | **type** | **str** | Object type | **agg_function** | **str** | Agg function. Empty if a stored metric is used. | [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] diff --git a/gooddata-api-client/docs/OrganizationControllerApi.md b/gooddata-api-client/docs/OrganizationControllerApi.md index 01337fe8e..14477eb36 100644 --- a/gooddata-api-client/docs/OrganizationControllerApi.md +++ b/gooddata-api-client/docs/OrganizationControllerApi.md @@ -302,6 +302,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", @@ -495,6 +498,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 998482830..e74f22a9f 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -150,10 +150,10 @@ with gooddata_api_client.ApiClient() as api_client: ], notification_channels=[ DeclarativeNotificationChannel( + allowed_recipients="INTERNAL", custom_dashboard_url="custom_dashboard_url_example", description="This is a channel", destination=DeclarativeNotificationChannelDestination(None), - enable_multiple_recipients=True, id="notification-channel-1", name="channel", ), @@ -184,6 +184,9 @@ with gooddata_api_client.ApiClient() as api_client: name="Alpha corporation", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", @@ -291,6 +294,10 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeWorkspace( automations=[ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -329,10 +336,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ], cache_extra_limit=1, @@ -354,6 +416,26 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + filter_views=[ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ], hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( diff --git a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md index 48404ccf0..a2da7da15 100644 --- a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md @@ -600,6 +600,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", @@ -793,6 +796,9 @@ with gooddata_api_client.ApiClient() as api_client: name="name_example", oauth_client_id="oauth_client_id_example", oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, oauth_issuer_id="myOidcProvider", oauth_issuer_location="oauth_issuer_location_example", oauth_subject_id_claim="oid", diff --git a/gooddata-api-client/docs/PdmLdmRequest.md b/gooddata-api-client/docs/PdmLdmRequest.md index 17a58ddbb..370f6c72f 100644 --- a/gooddata-api-client/docs/PdmLdmRequest.md +++ b/gooddata-api-client/docs/PdmLdmRequest.md @@ -6,6 +6,7 @@ PDM additions wrapper. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sqls** | [**[PdmSql]**](PdmSql.md) | List of SQL datasets. | [optional] +**table_overrides** | [**[TableOverride]**](TableOverride.md) | (BETA) List of table overrides. | [optional] **tables** | [**[DeclarativeTable]**](DeclarativeTable.md) | List of physical database tables. | [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] diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index 17f04a613..bc1e7b006 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -46,13 +46,13 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = smart_functions_api.SmartFunctionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier chat_request = ChatRequest( - chat_history_thread_id="chat_history_thread_id_example", limit_create=3, limit_create_context=10, limit_search=5, question="question_example", relevant_score_threshold=0.4, search_score_threshold=0.9, + thread_id_suffix="thread_id_suffix_example", title_to_descriptor_ratio=0.7, user_context=UserContext( active_object=ActiveObjectIdentification( @@ -133,8 +133,8 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier chat_history_request = ChatHistoryRequest( chat_history_interaction_id=1, - chat_history_thread_id="chat_history_thread_id_example", reset=True, + thread_id_suffix="thread_id_suffix_example", user_feedback="POSITIVE", ) # ChatHistoryRequest | diff --git a/gooddata-api-client/docs/TableOverride.md b/gooddata-api-client/docs/TableOverride.md new file mode 100644 index 000000000..0fbb19402 --- /dev/null +++ b/gooddata-api-client/docs/TableOverride.md @@ -0,0 +1,14 @@ +# TableOverride + +Table override settings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**columns** | [**[ColumnOverride]**](ColumnOverride.md) | An array of column overrides | +**path** | **[str]** | Path for the table. | +**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) + + diff --git a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index 85916d695..317d4da6c 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -329,6 +329,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -351,10 +369,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -6119,6 +6192,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -6141,10 +6232,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( @@ -7570,6 +7716,24 @@ with gooddata_api_client.ApiClient() as api_client: alert=JsonApiAutomationInAttributesAlert( condition=AlertCondition(), execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", + type="label", + ), + ), + local_identifier="2", + show_all_values=False, + ), + ], + aux_measures=[ + MeasureItem( + definition=MeasureDefinition(), + local_identifier="metric_1", + ), + ], filters=[ FilterDefinition(), ], @@ -7592,10 +7756,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + 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=[ "tags_example", ], title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + ), + ), + ], ), id="id1", relationships=JsonApiAutomationInRelationships( diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index caa19de11..6133d9d02 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -553,6 +553,10 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeWorkspace( automations=[ DeclarativeAutomation( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -591,10 +595,65 @@ with gooddata_api_client.ApiClient() as api_client: timezone="Europe/Prague", ), state="ACTIVE", + 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={}, + ), + ), + ], ), ], cache_extra_limit=1, @@ -616,6 +675,26 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + filter_views=[ + DeclarativeFilterView( + analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( + id="dashboard123", + type="analyticalDashboard", + ), + content=JsonNode(), + description="description_example", + id="filterView-1", + is_default=True, + tags=[ + "["Revenue","Sales"]", + ], + title="title_example", + user=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + ), + ], hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( diff --git a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py index c239a4e80..38dc1af63 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_views_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_views_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView from gooddata_api_client.model.json_api_filter_view_in_document import JsonApiFilterViewInDocument from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList @@ -367,6 +368,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': ([DeclarativeFilterView],), + 'auth': [], + 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', + 'operation_id': 'get_filter_views', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'exclude', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'exclude', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('exclude',): { + + "ACTIVITY_INFO": "ACTIVITY_INFO" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'exclude': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'exclude': 'exclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'exclude': 'query', + }, + 'collection_format_map': { + 'exclude': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.patch_entity_filter_views_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFilterViewOutDocument,), @@ -449,6 +510,60 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.set_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', + 'operation_id': 'set_filter_views', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'declarative_filter_view', + ], + 'required': [ + 'workspace_id', + 'declarative_filter_view', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'declarative_filter_view': + ([DeclarativeFilterView],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'declarative_filter_view': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.update_entity_filter_views_endpoint = _Endpoint( settings={ 'response_type': (JsonApiFilterViewOutDocument,), @@ -885,6 +1000,90 @@ def get_entity_filter_views( object_id return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + def get_filter_views( + self, + workspace_id, + **kwargs + ): + """Get filter views # noqa: E501 + + Retrieve filter views for the specific workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_filter_views(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + exclude ([str]): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [DeclarativeFilterView] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_filter_views_endpoint.call_with_http_info(**kwargs) + def patch_entity_filter_views( self, workspace_id, @@ -977,6 +1176,93 @@ def patch_entity_filter_views( json_api_filter_view_patch_document return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) + def set_filter_views( + self, + workspace_id, + declarative_filter_view, + **kwargs + ): + """Set filter views # noqa: E501 + + Set filter views for the specific workspace. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_filter_views(workspace_id, declarative_filter_view, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + declarative_filter_view ([DeclarativeFilterView]): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['declarative_filter_view'] = \ + declarative_filter_view + return self.set_filter_views_endpoint.call_with_http_info(**kwargs) + def update_entity_filter_views( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/layout_api.py b/gooddata-api-client/gooddata_api_client/api/layout_api.py index 1836879e0..a460a75de 100644 --- a/gooddata-api-client/gooddata_api_client/api/layout_api.py +++ b/gooddata-api-client/gooddata_api_client/api/layout_api.py @@ -26,6 +26,7 @@ from gooddata_api_client.model.declarative_automation import DeclarativeAutomation from gooddata_api_client.model.declarative_data_source_permissions import DeclarativeDataSourcePermissions from gooddata_api_client.model.declarative_data_sources import DeclarativeDataSources +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView from gooddata_api_client.model.declarative_model import DeclarativeModel from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels from gooddata_api_client.model.declarative_organization import DeclarativeOrganization @@ -264,6 +265,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': ([DeclarativeFilterView],), + 'auth': [], + 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', + 'operation_id': 'get_filter_views', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'exclude', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'exclude', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('exclude',): { + + "ACTIVITY_INFO": "ACTIVITY_INFO" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'exclude': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'exclude': 'exclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'exclude': 'query', + }, + 'collection_format_map': { + 'exclude': 'multi', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_logical_model_endpoint = _Endpoint( settings={ 'response_type': (DeclarativeModel,), @@ -1340,6 +1401,60 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.set_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/layout/workspaces/{workspaceId}/filterViews', + 'operation_id': 'set_filter_views', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'declarative_filter_view', + ], + 'required': [ + 'workspace_id', + 'declarative_filter_view', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'declarative_filter_view': + ([DeclarativeFilterView],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'declarative_filter_view': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.set_logical_model_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2180,6 +2295,90 @@ def get_data_sources_layout( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.get_data_sources_layout_endpoint.call_with_http_info(**kwargs) + def get_filter_views( + self, + workspace_id, + **kwargs + ): + """Get filter views # noqa: E501 + + Retrieve filter views for the specific workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_filter_views(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + exclude ([str]): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + [DeclarativeFilterView] + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_filter_views_endpoint.call_with_http_info(**kwargs) + def get_logical_model( self, workspace_id, @@ -3986,6 +4185,93 @@ def set_data_source_permissions( declarative_data_source_permissions return self.set_data_source_permissions_endpoint.call_with_http_info(**kwargs) + def set_filter_views( + self, + workspace_id, + declarative_filter_view, + **kwargs + ): + """Set filter views # noqa: E501 + + Set filter views for the specific workspace. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_filter_views(workspace_id, declarative_filter_view, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + declarative_filter_view ([DeclarativeFilterView]): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['declarative_filter_view'] = \ + declarative_filter_view + return self.set_filter_views_endpoint.call_with_http_info(**kwargs) + def set_logical_model( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/model/alert_afm.py b/gooddata-api-client/gooddata_api_client/model/alert_afm.py index 7d148b2c9..2aafb7735 100644 --- a/gooddata-api-client/gooddata_api_client/model/alert_afm.py +++ b/gooddata-api-client/gooddata_api_client/model/alert_afm.py @@ -31,8 +31,10 @@ def lazy_import(): + from gooddata_api_client.model.attribute_item import AttributeItem from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.measure_item import MeasureItem + globals()['AttributeItem'] = AttributeItem globals()['FilterDefinition'] = FilterDefinition globals()['MeasureItem'] = MeasureItem @@ -67,6 +69,8 @@ class AlertAfm(ModelNormal): validations = { ('measures',): { }, + ('attributes',): { + }, } @cached_property @@ -94,6 +98,8 @@ def openapi_types(): return { 'filters': ([FilterDefinition],), # noqa: E501 'measures': ([MeasureItem],), # noqa: E501 + 'attributes': ([AttributeItem],), # noqa: E501 + 'aux_measures': ([MeasureItem],), # noqa: E501 } @cached_property @@ -104,6 +110,8 @@ def discriminator(): attribute_map = { 'filters': 'filters', # noqa: E501 'measures': 'measures', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + 'aux_measures': 'auxMeasures', # noqa: E501 } read_only_vars = { @@ -151,6 +159,8 @@ def _from_openapi_data(cls, filters, measures, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes ([AttributeItem]): Attributes to be used in the computation.. [optional] # noqa: E501 + aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -242,6 +252,8 @@ def __init__(self, filters, measures, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + attributes ([AttributeItem]): Attributes to be used in the computation.. [optional] # noqa: E501 + aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py b/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py new file mode 100644 index 000000000..512dd3c46 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_tabular_export.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.tabular_export_request import TabularExportRequest + globals()['TabularExportRequest'] = TabularExportRequest + + +class AutomationTabularExport(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'request_payload': (TabularExportRequest,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'request_payload': 'requestPayload', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 + """AutomationTabularExport - a model defined in OpenAPI + + Args: + request_payload (TabularExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, request_payload, *args, **kwargs): # noqa: E501 + """AutomationTabularExport - a model defined in OpenAPI + + Args: + request_payload (TabularExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py b/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py new file mode 100644 index 000000000..cfffcd83d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/automation_visual_export.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.visual_export_request import VisualExportRequest + globals()['VisualExportRequest'] = VisualExportRequest + + +class AutomationVisualExport(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'request_payload': (VisualExportRequest,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'request_payload': 'requestPayload', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 + """AutomationVisualExport - a model defined in OpenAPI + + Args: + request_payload (VisualExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, request_payload, *args, **kwargs): # noqa: E501 + """AutomationVisualExport - a model defined in OpenAPI + + Args: + request_payload (VisualExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py index ea14dd9ca..5e82665f7 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py +++ b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py @@ -95,14 +95,14 @@ def openapi_types(): """ lazy_import() return { + 'chat_history_interaction_id': (int,), # noqa: E501 'interaction_finished': (bool,), # noqa: E501 - 'interaction_id': (int,), # noqa: E501 'question': (str,), # noqa: E501 'routing': (RouteResult,), # noqa: E501 - 'thread_id': (str,), # noqa: E501 'created_visualizations': (CreatedVisualizations,), # noqa: E501 'found_objects': (FoundObjects,), # noqa: E501 'text_response': (str,), # noqa: E501 + 'thread_id_suffix': (str,), # noqa: E501 } @cached_property @@ -111,14 +111,14 @@ def discriminator(): attribute_map = { + 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 'interaction_finished': 'interactionFinished', # noqa: E501 - 'interaction_id': 'interactionId', # noqa: E501 'question': 'question', # noqa: E501 'routing': 'routing', # noqa: E501 - 'thread_id': 'threadId', # noqa: E501 'created_visualizations': 'createdVisualizations', # noqa: E501 'found_objects': 'foundObjects', # noqa: E501 'text_response': 'textResponse', # noqa: E501 + 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 } read_only_vars = { @@ -128,15 +128,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, interaction_finished, interaction_id, question, routing, thread_id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 """ChatHistoryInteraction - a model defined in OpenAPI Args: + chat_history_interaction_id (int): Chat History interaction ID. Unique ID for each interaction. interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - interaction_id (int): Chat History interaction ID. Unique ID for each interaction. question (str): User question routing (RouteResult): - thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -172,6 +171,7 @@ def _from_openapi_data(cls, interaction_finished, interaction_id, question, rout created_visualizations (CreatedVisualizations): [optional] # noqa: E501 found_objects (FoundObjects): [optional] # noqa: E501 text_response (str): Text response for general questions.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -203,11 +203,10 @@ def _from_openapi_data(cls, interaction_finished, interaction_id, question, rout self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.chat_history_interaction_id = chat_history_interaction_id self.interaction_finished = interaction_finished - self.interaction_id = interaction_id self.question = question self.routing = routing - self.thread_id = thread_id for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -228,15 +227,14 @@ def _from_openapi_data(cls, interaction_finished, interaction_id, question, rout ]) @convert_js_args_to_python_args - def __init__(self, interaction_finished, interaction_id, question, routing, thread_id, *args, **kwargs): # noqa: E501 + def __init__(self, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 """ChatHistoryInteraction - a model defined in OpenAPI Args: + chat_history_interaction_id (int): Chat History interaction ID. Unique ID for each interaction. interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - interaction_id (int): Chat History interaction ID. Unique ID for each interaction. question (str): User question routing (RouteResult): - thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -272,6 +270,7 @@ def __init__(self, interaction_finished, interaction_id, question, routing, thre created_visualizations (CreatedVisualizations): [optional] # noqa: E501 found_objects (FoundObjects): [optional] # noqa: E501 text_response (str): Text response for general questions.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -301,11 +300,10 @@ def __init__(self, interaction_finished, interaction_id, question, routing, thre self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.chat_history_interaction_id = chat_history_interaction_id self.interaction_finished = interaction_finished - self.interaction_id = interaction_id self.question = question self.routing = routing - self.thread_id = thread_id for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_request.py b/gooddata-api-client/gooddata_api_client/model/chat_history_request.py index ccdd1559d..ee46df157 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_request.py +++ b/gooddata-api-client/gooddata_api_client/model/chat_history_request.py @@ -88,8 +88,8 @@ def openapi_types(): """ return { 'chat_history_interaction_id': (int,), # noqa: E501 - 'chat_history_thread_id': (str,), # noqa: E501 'reset': (bool,), # noqa: E501 + 'thread_id_suffix': (str,), # noqa: E501 'user_feedback': (str,), # noqa: E501 } @@ -100,8 +100,8 @@ def discriminator(): attribute_map = { 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'chat_history_thread_id': 'chatHistoryThreadId', # noqa: E501 'reset': 'reset', # noqa: E501 + 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 'user_feedback': 'userFeedback', # noqa: E501 } @@ -147,8 +147,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) chat_history_interaction_id (int): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - chat_history_thread_id (str): Chat History thread ID. Optional, backend can create it if not provided.. [optional] # noqa: E501 reset (bool): User feedback.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 user_feedback (str): User feedback.. [optional] # noqa: E501 """ @@ -236,8 +236,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) chat_history_interaction_id (int): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - chat_history_thread_id (str): Chat History thread ID. Optional, backend can create it if not provided.. [optional] # noqa: E501 reset (bool): User feedback.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 user_feedback (str): User feedback.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/chat_request.py b/gooddata-api-client/gooddata_api_client/model/chat_request.py index b7d36f54b..ad6687b1e 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_request.py +++ b/gooddata-api-client/gooddata_api_client/model/chat_request.py @@ -92,12 +92,12 @@ def openapi_types(): lazy_import() return { 'question': (str,), # noqa: E501 - 'chat_history_thread_id': (str,), # noqa: E501 'limit_create': (int,), # noqa: E501 'limit_create_context': (int,), # noqa: E501 'limit_search': (int,), # noqa: E501 'relevant_score_threshold': (float,), # noqa: E501 'search_score_threshold': (float,), # noqa: E501 + 'thread_id_suffix': (str,), # noqa: E501 'title_to_descriptor_ratio': (float,), # noqa: E501 'user_context': (UserContext,), # noqa: E501 } @@ -109,12 +109,12 @@ def discriminator(): attribute_map = { 'question': 'question', # noqa: E501 - 'chat_history_thread_id': 'chatHistoryThreadId', # noqa: E501 'limit_create': 'limitCreate', # noqa: E501 'limit_create_context': 'limitCreateContext', # noqa: E501 'limit_search': 'limitSearch', # noqa: E501 'relevant_score_threshold': 'relevantScoreThreshold', # noqa: E501 'search_score_threshold': 'searchScoreThreshold', # noqa: E501 + 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 'title_to_descriptor_ratio': 'titleToDescriptorRatio', # noqa: E501 'user_context': 'userContext', # noqa: E501 } @@ -163,12 +163,12 @@ def _from_openapi_data(cls, question, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests.. [optional] # noqa: E501 limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.4 # noqa: E501 search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 user_context (UserContext): [optional] # noqa: E501 """ @@ -260,12 +260,12 @@ def __init__(self, question, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests.. [optional] # noqa: E501 limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.4 # noqa: E501 search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 user_context (UserContext): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/chat_result.py b/gooddata-api-client/gooddata_api_client/model/chat_result.py index 8d9209aa5..e1e8ed057 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_result.py +++ b/gooddata-api-client/gooddata_api_client/model/chat_result.py @@ -93,10 +93,10 @@ def openapi_types(): lazy_import() return { 'routing': (RouteResult,), # noqa: E501 - 'chat_history_thread_id': (str,), # noqa: E501 'created_visualizations': (CreatedVisualizations,), # noqa: E501 'found_objects': (FoundObjects,), # noqa: E501 'text_response': (str,), # noqa: E501 + 'thread_id_suffix': (str,), # noqa: E501 } @cached_property @@ -106,10 +106,10 @@ def discriminator(): attribute_map = { 'routing': 'routing', # noqa: E501 - 'chat_history_thread_id': 'chatHistoryThreadId', # noqa: E501 'created_visualizations': 'createdVisualizations', # noqa: E501 'found_objects': 'foundObjects', # noqa: E501 'text_response': 'textResponse', # noqa: E501 + 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 } read_only_vars = { @@ -156,10 +156,10 @@ def _from_openapi_data(cls, routing, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests.. [optional] # noqa: E501 created_visualizations (CreatedVisualizations): [optional] # noqa: E501 found_objects (FoundObjects): [optional] # noqa: E501 text_response (str): Text response for general questions.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -249,10 +249,10 @@ def __init__(self, routing, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_thread_id (str): Chat History thread ID. Backend persists chat history and returns ID for further requests.. [optional] # noqa: E501 created_visualizations (CreatedVisualizations): [optional] # noqa: E501 found_objects (FoundObjects): [optional] # noqa: E501 text_response (str): Text response for general questions.. [optional] # noqa: E501 + thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/column_override.py b/gooddata-api-client/gooddata_api_client/model/column_override.py new file mode 100644 index 000000000..9a2c0d8b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/column_override.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ColumnOverride(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('label_type',): { + 'TEXT': "TEXT", + 'HYPERLINK': "HYPERLINK", + 'GEO': "GEO", + 'GEO_LONGITUDE': "GEO_LONGITUDE", + 'GEO_LATITUDE': "GEO_LATITUDE", + 'IMAGE': "IMAGE", + }, + ('ldm_type_override',): { + 'FACT': "FACT", + 'LABEL': "LABEL", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'label_target_column': (str,), # noqa: E501 + 'label_type': (str,), # noqa: E501 + 'ldm_type_override': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'label_target_column': 'labelTargetColumn', # noqa: E501 + 'label_type': 'labelType', # noqa: E501 + 'ldm_type_override': 'ldmTypeOverride', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """ColumnOverride - a model defined in OpenAPI + + Args: + name (str): Column name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label_target_column (str): Specifies the attribute's column to which this label is associated.. [optional] # noqa: E501 + label_type (str): Label type for the target attribute.. [optional] # noqa: E501 + ldm_type_override (str): Logical Data Model type for the column.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """ColumnOverride - a model defined in OpenAPI + + Args: + name (str): Column name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label_target_column (str): Specifies the attribute's column to which this label is associated.. [optional] # noqa: E501 + label_type (str): Label type for the target attribute.. [optional] # noqa: E501 + ldm_type_override (str): Logical Data Model type for the column.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py new file mode 100644 index 000000000..d2298ddf1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard_identifier.py @@ -0,0 +1,286 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class DeclarativeAnalyticalDashboardIdentifier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'ANALYTICALDASHBOARD': "analyticalDashboard", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """DeclarativeAnalyticalDashboardIdentifier - a model defined in OpenAPI + + Args: + id (str): Identifier of the analytical dashboard. + + Keyword Args: + type (str): A type.. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + type = kwargs.get('type', "analyticalDashboard") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """DeclarativeAnalyticalDashboardIdentifier - a model defined in OpenAPI + + Args: + id (str): Identifier of the analytical dashboard. + + Keyword Args: + type (str): A type.. defaults to "analyticalDashboard", must be one of ["analyticalDashboard", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + type = kwargs.get('type', "analyticalDashboard") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py b/gooddata-api-client/gooddata_api_client/model/declarative_automation.py index 4784d20f4..8bfa52ff2 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_automation.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_automation.py @@ -32,11 +32,17 @@ def lazy_import(): from gooddata_api_client.model.automation_schedule import AutomationSchedule + from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport + from gooddata_api_client.model.automation_visual_export import AutomationVisualExport + from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier from gooddata_api_client.model.json_node import JsonNode globals()['AutomationSchedule'] = AutomationSchedule + globals()['AutomationTabularExport'] = AutomationTabularExport + globals()['AutomationVisualExport'] = AutomationVisualExport + globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier globals()['DeclarativeExportDefinitionIdentifier'] = DeclarativeExportDefinitionIdentifier globals()['DeclarativeNotificationChannelIdentifier'] = DeclarativeNotificationChannelIdentifier globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier @@ -99,11 +105,15 @@ class DeclarativeAutomation(ModelNormal): }, ('recipients',): { }, + ('tabular_exports',): { + }, ('tags',): { }, ('title',): { 'max_length': 255, }, + ('visual_exports',): { + }, } @cached_property @@ -130,6 +140,7 @@ def openapi_types(): lazy_import() return { 'id': (str,), # noqa: E501 + 'analytical_dashboard': (DeclarativeAnalyticalDashboardIdentifier,), # noqa: E501 'created_at': (str, none_type,), # noqa: E501 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 @@ -142,8 +153,10 @@ def openapi_types(): 'recipients': ([DeclarativeUserIdentifier],), # noqa: E501 'schedule': (AutomationSchedule,), # noqa: E501 'state': (str,), # noqa: E501 + 'tabular_exports': ([AutomationTabularExport],), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 + 'visual_exports': ([AutomationVisualExport],), # noqa: E501 } @cached_property @@ -153,6 +166,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 + 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'description': 'description', # noqa: E501 @@ -165,8 +179,10 @@ def discriminator(): 'recipients': 'recipients', # noqa: E501 'schedule': 'schedule', # noqa: E501 'state': 'state', # noqa: E501 + 'tabular_exports': 'tabularExports', # noqa: E501 'tags': 'tags', # noqa: E501 'title': 'title', # noqa: E501 + 'visual_exports': 'visualExports', # noqa: E501 } read_only_vars = { @@ -213,6 +229,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): [optional] # noqa: E501 @@ -225,8 +242,10 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 schedule (AutomationSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] if omitted the server will use the default value of "ACTIVE" # noqa: E501 + tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -316,6 +335,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): [optional] # noqa: E501 @@ -328,8 +348,10 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 recipients ([DeclarativeUserIdentifier]): [optional] # noqa: E501 schedule (AutomationSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] if omitted the server will use the default value of "ACTIVE" # noqa: E501 + tabular_exports ([AutomationTabularExport]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([AutomationVisualExport]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py b/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py new file mode 100644 index 000000000..c302b8a48 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_filter_view.py @@ -0,0 +1,323 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier + from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier + from gooddata_api_client.model.json_node import JsonNode + globals()['DeclarativeAnalyticalDashboardIdentifier'] = DeclarativeAnalyticalDashboardIdentifier + globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + globals()['JsonNode'] = JsonNode + + +class DeclarativeFilterView(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 255, + }, + ('tags',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'analytical_dashboard': (DeclarativeAnalyticalDashboardIdentifier,), # noqa: E501 + 'content': (JsonNode,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'is_default': (bool,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'user': (DeclarativeUserIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_default': 'isDefault', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'user': 'user', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 + """DeclarativeFilterView - a model defined in OpenAPI + + Args: + id (str): FilterView object ID. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 + content (JsonNode): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + user (DeclarativeUserIdentifier): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, title, *args, **kwargs): # noqa: E501 + """DeclarativeFilterView - a model defined in OpenAPI + + Args: + id (str): FilterView object ID. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + analytical_dashboard (DeclarativeAnalyticalDashboardIdentifier): [optional] # noqa: E501 + content (JsonNode): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_default (bool): Indicator whether the filter view should by applied by default.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + user (DeclarativeUserIdentifier): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py index efb60b4a9..1ca790178 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py @@ -60,6 +60,10 @@ class DeclarativeNotificationChannel(ModelNormal): """ allowed_values = { + ('allowed_recipients',): { + 'CREATOR': "CREATOR", + 'INTERNAL': "INTERNAL", + }, ('destination_type',): { 'None': None, 'WEBHOOK': "WEBHOOK", @@ -106,11 +110,11 @@ def openapi_types(): lazy_import() return { 'id': (str,), # noqa: E501 + 'allowed_recipients': (str,), # noqa: E501 'custom_dashboard_url': (str,), # noqa: E501 'description': (str,), # noqa: E501 'destination': (DeclarativeNotificationChannelDestination,), # noqa: E501 'destination_type': (str, none_type,), # noqa: E501 - 'enable_multiple_recipients': (bool,), # noqa: E501 'name': (str,), # noqa: E501 } @@ -121,11 +125,11 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 + 'allowed_recipients': 'allowedRecipients', # noqa: E501 'custom_dashboard_url': 'customDashboardUrl', # noqa: E501 'description': 'description', # noqa: E501 'destination': 'destination', # noqa: E501 'destination_type': 'destinationType', # noqa: E501 - 'enable_multiple_recipients': 'enableMultipleRecipients', # noqa: E501 'name': 'name', # noqa: E501 } @@ -174,11 +178,11 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization . [optional] if omitted the server will use the default value of "INTERNAL" # noqa: E501 custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}.. [optional] # noqa: E501 description (str): Description of a notification channel.. [optional] # noqa: E501 destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 destination_type (str, none_type): [optional] # noqa: E501 - enable_multiple_recipients (bool): Whether notifications sent to the channel can have multiple recipients.. [optional] if omitted the server will use the default value of True # noqa: E501 name (str): Name of a notification channel.. [optional] # noqa: E501 """ @@ -269,11 +273,11 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + allowed_recipients (str): Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization . [optional] if omitted the server will use the default value of "INTERNAL" # noqa: E501 custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}.. [optional] # noqa: E501 description (str): Description of a notification channel.. [optional] # noqa: E501 destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 destination_type (str, none_type): [optional] # noqa: E501 - enable_multiple_recipients (bool): Whether notifications sent to the channel can have multiple recipients.. [optional] if omitted the server will use the default value of True # noqa: E501 name (str): Name of a notification channel.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py index 28d2ed88a..ac2012de6 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_organization_info.py @@ -93,6 +93,8 @@ class DeclarativeOrganizationInfo(ModelNormal): ('oauth_client_secret',): { 'max_length': 255, }, + ('oauth_custom_auth_attributes',): { + }, ('oauth_issuer_id',): { 'max_length': 255, }, @@ -138,6 +140,7 @@ def openapi_types(): 'jit_enabled': (bool,), # noqa: E501 'oauth_client_id': (str,), # noqa: E501 'oauth_client_secret': (str,), # noqa: E501 + 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -162,6 +165,7 @@ def discriminator(): 'jit_enabled': 'jitEnabled', # noqa: E501 'oauth_client_id': 'oauthClientId', # noqa: E501 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 + 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -223,6 +227,7 @@ def _from_openapi_data(cls, hostname, id, name, permissions, *args, **kwargs): jit_enabled (bool): Flag to enable/disable JIT provisioning in the given organization. [optional] # noqa: E501 oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -330,6 +335,7 @@ def __init__(self, hostname, id, name, permissions, *args, **kwargs): # noqa: E jit_enabled (bool): Flag to enable/disable JIT provisioning in the given organization. [optional] # noqa: E501 oauth_client_id (str): Identifier of the authentication provider. [optional] # noqa: E501 oauth_client_secret (str): Communication secret of the authentication provider (never returned back).. [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): URI of the authentication provider.. [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py index cc6a6657a..052d59877 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -76,6 +76,7 @@ class DeclarativeSetting(ModelNormal): 'OPENAI_CONFIG': "OPENAI_CONFIG", 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", 'ALERT': "ALERT", + 'SEPARATORS': "SEPARATORS", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py index 10adec46b..00c85223c 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.declarative_automation import DeclarativeAutomation from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting + from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView from gooddata_api_client.model.declarative_setting import DeclarativeSetting from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter @@ -42,6 +43,7 @@ def lazy_import(): from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier globals()['DeclarativeAutomation'] = DeclarativeAutomation globals()['DeclarativeCustomApplicationSetting'] = DeclarativeCustomApplicationSetting + globals()['DeclarativeFilterView'] = DeclarativeFilterView globals()['DeclarativeSetting'] = DeclarativeSetting globals()['DeclarativeSingleWorkspacePermission'] = DeclarativeSingleWorkspacePermission globals()['DeclarativeUserDataFilter'] = DeclarativeUserDataFilter @@ -135,6 +137,7 @@ def openapi_types(): 'description': (str,), # noqa: E501 'early_access': (str,), # noqa: E501 'early_access_values': ([str],), # noqa: E501 + 'filter_views': ([DeclarativeFilterView],), # noqa: E501 'hierarchy_permissions': ([DeclarativeWorkspaceHierarchyPermission],), # noqa: E501 'model': (DeclarativeWorkspaceModel,), # noqa: E501 'parent': (WorkspaceIdentifier,), # noqa: E501 @@ -159,6 +162,7 @@ def discriminator(): 'description': 'description', # noqa: E501 'early_access': 'earlyAccess', # noqa: E501 'early_access_values': 'earlyAccessValues', # noqa: E501 + 'filter_views': 'filterViews', # noqa: E501 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 'model': 'model', # noqa: E501 'parent': 'parent', # noqa: E501 @@ -220,6 +224,7 @@ def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 description (str): Description of the workspace. [optional] # noqa: E501 early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 + filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 model (DeclarativeWorkspaceModel): [optional] # noqa: E501 parent (WorkspaceIdentifier): [optional] # noqa: E501 @@ -325,6 +330,7 @@ def __init__(self, id, name, *args, **kwargs): # noqa: E501 description (str): Description of the workspace. [optional] # noqa: E501 early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 + filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 model (DeclarativeWorkspaceModel): [optional] # noqa: E501 parent (WorkspaceIdentifier): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py b/gooddata-api-client/gooddata_api_client/model/dim_attribute.py index 54eeb5788..f64d90fa1 100644 --- a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py +++ b/gooddata-api-client/gooddata_api_client/model/dim_attribute.py @@ -86,6 +86,7 @@ def openapi_types(): """ return { 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -96,6 +97,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 'type': 'type', # noqa: E501 } @@ -106,11 +108,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 """DimAttribute - a model defined in OpenAPI Args: id (str): ID of the object + title (str): Title of attribute. Keyword Args: type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 @@ -177,6 +180,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id + self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -198,11 +202,12 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 + def __init__(self, id, title, *args, **kwargs): # noqa: E501 """DimAttribute - a model defined in OpenAPI Args: id (str): ID of the object + title (str): Title of attribute. Keyword Args: type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # noqa: E501 @@ -267,6 +272,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id + self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py b/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py index b10f69013..930043f0d 100644 --- a/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py +++ b/gooddata-api-client/gooddata_api_client/model/generate_ldm_request.py @@ -176,7 +176,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 date_granularities (str): Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).. [optional] # noqa: E501 denorm_prefix (str): Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.. [optional] # noqa: E501 fact_prefix (str): Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.. [optional] # noqa: E501 - generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] # noqa: E501 + generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] if omitted the server will use the default value of False # noqa: E501 grain_multivalue_reference_prefix (str): Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.. [optional] # noqa: E501 grain_prefix (str): Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.. [optional] # noqa: E501 grain_reference_prefix (str): Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.. [optional] # noqa: E501 @@ -188,7 +188,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 separator (str): A separator between prefixes and the names. Default is \"__\".. [optional] if omitted the server will use the default value of "__" # noqa: E501 table_prefix (str): Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 view_prefix (str): Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] # noqa: E501 + wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] if omitted the server will use the default value of "wdf" # noqa: E501 workspace_id (str): Optional workspace id.. [optional] # noqa: E501 """ @@ -278,7 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 date_granularities (str): Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).. [optional] # noqa: E501 denorm_prefix (str): Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.. [optional] # noqa: E501 fact_prefix (str): Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.. [optional] # noqa: E501 - generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] # noqa: E501 + generate_long_ids (bool): A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.. [optional] if omitted the server will use the default value of False # noqa: E501 grain_multivalue_reference_prefix (str): Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.. [optional] # noqa: E501 grain_prefix (str): Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.. [optional] # noqa: E501 grain_reference_prefix (str): Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.. [optional] # noqa: E501 @@ -290,7 +290,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 separator (str): A separator between prefixes and the names. Default is \"__\".. [optional] if omitted the server will use the default value of "__" # noqa: E501 table_prefix (str): Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.. [optional] # noqa: E501 view_prefix (str): Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.. [optional] # noqa: E501 - wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] # noqa: E501 + wdf_prefix (str): Column serving as workspace data filter. No labels are auto generated for such columns.. [optional] if omitted the server will use the default value of "wdf" # noqa: E501 workspace_id (str): Optional workspace id.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py index 225586d70..1c758edce 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes.py @@ -33,8 +33,12 @@ def lazy_import(): from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule + from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule + globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner + globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner class JsonApiAutomationInAttributes(ModelNormal): @@ -112,8 +116,10 @@ def openapi_types(): 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 'state': (str,), # noqa: E501 + 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 + 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 } @cached_property @@ -129,8 +135,10 @@ def discriminator(): 'metadata': 'metadata', # noqa: E501 'schedule': 'schedule', # noqa: E501 'state': 'state', # noqa: E501 + 'tabular_exports': 'tabularExports', # noqa: E501 'tags': 'tags', # noqa: E501 'title': 'title', # noqa: E501 + 'visual_exports': 'visualExports', # noqa: E501 } read_only_vars = { @@ -181,8 +189,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -275,8 +285,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Additional information for the automation.. [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py new file mode 100644 index 000000000..39b37f935 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_tabular_exports_inner.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.tabular_export_request import TabularExportRequest + globals()['TabularExportRequest'] = TabularExportRequest + + +class JsonApiAutomationInAttributesTabularExportsInner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'request_payload': (TabularExportRequest,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'request_payload': 'requestPayload', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 + """JsonApiAutomationInAttributesTabularExportsInner - a model defined in OpenAPI + + Args: + request_payload (TabularExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, request_payload, *args, **kwargs): # noqa: E501 + """JsonApiAutomationInAttributesTabularExportsInner - a model defined in OpenAPI + + Args: + request_payload (TabularExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py new file mode 100644 index 000000000..8f7b1b64c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_visual_exports_inner.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.visual_export_request import VisualExportRequest + globals()['VisualExportRequest'] = VisualExportRequest + + +class JsonApiAutomationInAttributesVisualExportsInner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'request_payload': (VisualExportRequest,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'request_payload': 'requestPayload', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, request_payload, *args, **kwargs): # noqa: E501 + """JsonApiAutomationInAttributesVisualExportsInner - a model defined in OpenAPI + + Args: + request_payload (VisualExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, request_payload, *args, **kwargs): # noqa: E501 + """JsonApiAutomationInAttributesVisualExportsInner - a model defined in OpenAPI + + Args: + request_payload (VisualExportRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.request_payload = request_payload + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py index d9a9c9b38..dfa1e0556 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py @@ -33,8 +33,12 @@ def lazy_import(): from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule + from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule + globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner + globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner class JsonApiAutomationOutAttributes(ModelNormal): @@ -114,8 +118,10 @@ def openapi_types(): 'modified_at': (datetime,), # noqa: E501 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 'state': (str,), # noqa: E501 + 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 + 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 } @cached_property @@ -133,8 +139,10 @@ def discriminator(): 'modified_at': 'modifiedAt', # noqa: E501 'schedule': 'schedule', # noqa: E501 'state': 'state', # noqa: E501 + 'tabular_exports': 'tabularExports', # noqa: E501 'tags': 'tags', # noqa: E501 'title': 'title', # noqa: E501 + 'visual_exports': 'visualExports', # noqa: E501 } read_only_vars = { @@ -187,8 +195,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 modified_at (datetime): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -283,8 +293,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 modified_at (datetime): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py index 94a54b5dc..f5b0e3356 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_in_attributes.py @@ -74,6 +74,8 @@ class JsonApiOrganizationInAttributes(ModelNormal): ('oauth_client_secret',): { 'max_length': 255, }, + ('oauth_custom_auth_attributes',): { + }, ('oauth_issuer_id',): { 'max_length': 255, }, @@ -114,6 +116,7 @@ def openapi_types(): 'name': (str, none_type,), # noqa: E501 'oauth_client_id': (str,), # noqa: E501 'oauth_client_secret': (str,), # noqa: E501 + 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -133,6 +136,7 @@ def discriminator(): 'name': 'name', # noqa: E501 'oauth_client_id': 'oauthClientId', # noqa: E501 'oauth_client_secret': 'oauthClientSecret', # noqa: E501 + 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -187,6 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_client_secret (str): [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -283,6 +288,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 oauth_client_secret (str): [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py index 23da345dd..d257dee8d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_attributes.py @@ -75,6 +75,8 @@ class JsonApiOrganizationOutAttributes(ModelNormal): ('oauth_client_id',): { 'max_length': 255, }, + ('oauth_custom_auth_attributes',): { + }, ('oauth_issuer_id',): { 'max_length': 255, }, @@ -117,6 +119,7 @@ def openapi_types(): 'jit_enabled': (bool,), # noqa: E501 'name': (str, none_type,), # noqa: E501 'oauth_client_id': (str,), # noqa: E501 + 'oauth_custom_auth_attributes': ({str: (str,)},), # noqa: E501 'oauth_issuer_id': (str,), # noqa: E501 'oauth_issuer_location': (str,), # noqa: E501 'oauth_subject_id_claim': (str,), # noqa: E501 @@ -136,6 +139,7 @@ def discriminator(): 'jit_enabled': 'jitEnabled', # noqa: E501 'name': 'name', # noqa: E501 'oauth_client_id': 'oauthClientId', # noqa: E501 + 'oauth_custom_auth_attributes': 'oauthCustomAuthAttributes', # noqa: E501 'oauth_issuer_id': 'oauthIssuerId', # noqa: E501 'oauth_issuer_location': 'oauthIssuerLocation', # noqa: E501 'oauth_subject_id_claim': 'oauthSubjectIdClaim', # noqa: E501 @@ -190,6 +194,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 jit_enabled (bool): Flag to enable/disable JIT provisioning in the given organization. [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 @@ -286,6 +291,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 jit_enabled (bool): Flag to enable/disable JIT provisioning in the given organization. [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 oauth_client_id (str): [optional] # noqa: E501 + oauth_custom_auth_attributes ({str: (str,)}): Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.. [optional] # noqa: E501 oauth_issuer_id (str): Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.. [optional] # noqa: E501 oauth_issuer_location (str): [optional] # noqa: E501 oauth_subject_id_claim (str): Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py index bc88f5fc1..3b52be8d1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py @@ -72,6 +72,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'OPENAI_CONFIG': "OPENAI_CONFIG", 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", 'ALERT': "ALERT", + 'SEPARATORS': "SEPARATORS", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/metric.py b/gooddata-api-client/gooddata_api_client/model/metric.py index 378c9279e..69df26fe1 100644 --- a/gooddata-api-client/gooddata_api_client/model/metric.py +++ b/gooddata-api-client/gooddata_api_client/model/metric.py @@ -96,6 +96,7 @@ def openapi_types(): """ return { 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 'type': (str,), # noqa: E501 'agg_function': (str,), # noqa: E501 } @@ -107,6 +108,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 'type': 'type', # noqa: E501 'agg_function': 'aggFunction', # noqa: E501 } @@ -118,11 +120,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 """Metric - a model defined in OpenAPI Args: id (str): ID of the object + title (str): Title of metric. type (str): Object type Keyword Args: @@ -189,6 +192,7 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id + self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -210,11 +214,12 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 + def __init__(self, id, title, type, *args, **kwargs): # noqa: E501 """Metric - a model defined in OpenAPI Args: id (str): ID of the object + title (str): Title of metric. type (str): Object type Keyword Args: @@ -279,6 +284,7 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id + self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py b/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py index a473c0fae..4dae6455f 100644 --- a/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py +++ b/gooddata-api-client/gooddata_api_client/model/pdm_ldm_request.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.declarative_table import DeclarativeTable from gooddata_api_client.model.pdm_sql import PdmSql + from gooddata_api_client.model.table_override import TableOverride globals()['DeclarativeTable'] = DeclarativeTable globals()['PdmSql'] = PdmSql + globals()['TableOverride'] = TableOverride class PdmLdmRequest(ModelNormal): @@ -91,6 +93,7 @@ def openapi_types(): lazy_import() return { 'sqls': ([PdmSql],), # noqa: E501 + 'table_overrides': ([TableOverride],), # noqa: E501 'tables': ([DeclarativeTable],), # noqa: E501 } @@ -101,6 +104,7 @@ def discriminator(): attribute_map = { 'sqls': 'sqls', # noqa: E501 + 'table_overrides': 'tableOverrides', # noqa: E501 'tables': 'tables', # noqa: E501 } @@ -146,6 +150,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) sqls ([PdmSql]): List of SQL datasets.. [optional] # noqa: E501 + table_overrides ([TableOverride]): (BETA) List of table overrides.. [optional] # noqa: E501 tables ([DeclarativeTable]): List of physical database tables.. [optional] # noqa: E501 """ @@ -233,6 +238,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) sqls ([PdmSql]): List of SQL datasets.. [optional] # noqa: E501 + table_overrides ([TableOverride]): (BETA) List of table overrides.. [optional] # noqa: E501 tables ([DeclarativeTable]): List of physical database tables.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py index 84c75b20d..a2e4af6a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -76,6 +76,7 @@ class ResolvedSetting(ModelNormal): 'OPENAI_CONFIG': "OPENAI_CONFIG", 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", 'ALERT': "ALERT", + 'SEPARATORS': "SEPARATORS", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/table_override.py b/gooddata-api-client/gooddata_api_client/model/table_override.py new file mode 100644 index 000000000..fe442931e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/table_override.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.column_override import ColumnOverride + globals()['ColumnOverride'] = ColumnOverride + + +class TableOverride(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'columns': ([ColumnOverride],), # noqa: E501 + 'path': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'columns': 'columns', # noqa: E501 + 'path': 'path', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, columns, path, *args, **kwargs): # noqa: E501 + """TableOverride - a model defined in OpenAPI + + Args: + columns ([ColumnOverride]): An array of column overrides + path ([str]): Path for the table. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.columns = columns + self.path = path + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, columns, path, *args, **kwargs): # noqa: E501 + """TableOverride - a model defined in OpenAPI + + Args: + columns ([ColumnOverride]): An array of column overrides + path ([str]): Path for the table. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.columns = columns + self.path = path + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index b11481c67..604d8d1bd 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -52,6 +52,8 @@ from gooddata_api_client.model.attribute_item import AttributeItem from gooddata_api_client.model.attribute_result_header import AttributeResultHeader from gooddata_api_client.model.automation_schedule import AutomationSchedule +from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.model.automation_visual_export import AutomationVisualExport from gooddata_api_client.model.available_assignees import AvailableAssignees from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction from gooddata_api_client.model.chat_history_request import ChatHistoryRequest @@ -61,6 +63,7 @@ from gooddata_api_client.model.clustering_request import ClusteringRequest from gooddata_api_client.model.clustering_result import ClusteringResult from gooddata_api_client.model.column_location import ColumnLocation +from gooddata_api_client.model.column_override import ColumnOverride from gooddata_api_client.model.column_statistic import ColumnStatistic from gooddata_api_client.model.column_statistic_warning import ColumnStatisticWarning from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest @@ -90,6 +93,7 @@ from gooddata_api_client.model.date_filter import DateFilter from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension +from gooddata_api_client.model.declarative_analytical_dashboard_identifier import DeclarativeAnalyticalDashboardIdentifier from gooddata_api_client.model.declarative_analytical_dashboard_permission_assignment import DeclarativeAnalyticalDashboardPermissionAssignment from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee import DeclarativeAnalyticalDashboardPermissionForAssignee from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf @@ -119,6 +123,7 @@ from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload from gooddata_api_client.model.declarative_fact import DeclarativeFact from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext +from gooddata_api_client.model.declarative_filter_view import DeclarativeFilterView from gooddata_api_client.model.declarative_jwk import DeclarativeJwk from gooddata_api_client.model.declarative_jwk_specification import DeclarativeJwkSpecification from gooddata_api_client.model.declarative_label import DeclarativeLabel @@ -287,6 +292,8 @@ from gooddata_api_client.model.json_api_automation_in_attributes import JsonApiAutomationInAttributes from gooddata_api_client.model.json_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule +from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner +from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner from gooddata_api_client.model.json_api_automation_in_document import JsonApiAutomationInDocument from gooddata_api_client.model.json_api_automation_in_relationships import JsonApiAutomationInRelationships from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard @@ -780,6 +787,7 @@ from gooddata_api_client.model.sql_query_all_of import SqlQueryAllOf from gooddata_api_client.model.table import Table from gooddata_api_client.model.table_all_of import TableAllOf +from gooddata_api_client.model.table_override import TableOverride from gooddata_api_client.model.table_warning import TableWarning from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.test_definition_request import TestDefinitionRequest diff --git a/gooddata-sdk/gooddata_sdk/__init__.py b/gooddata-sdk/gooddata_sdk/__init__.py index 52e0607a2..122ede758 100644 --- a/gooddata-sdk/gooddata_sdk/__init__.py +++ b/gooddata-sdk/gooddata_sdk/__init__.py @@ -65,6 +65,7 @@ ExportCustomOverride, ExportRequest, ExportSettings, + VisualExportRequest, ) from gooddata_sdk.catalog.filter_by import CatalogFilterBy from gooddata_sdk.catalog.identifier import ( diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/request.py b/gooddata-sdk/gooddata_sdk/catalog/export/request.py index 591058479..a750d58e5 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/request.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/request.py @@ -1,17 +1,18 @@ # (C) 2023 GoodData Corporation from typing import Optional -import attr +from attrs import define from gooddata_api_client.model.custom_label import CustomLabel as ApiCustomLabel from gooddata_api_client.model.custom_metric import CustomMetric as ApiCustomMetric from gooddata_api_client.model.custom_override import CustomOverride as ApiCustomOverride from gooddata_api_client.model.settings import Settings as ApiSettings from gooddata_api_client.model.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.visual_export_request import VisualExportRequest as VisualExportRequestApi from gooddata_sdk.catalog.base import Base -@attr.s(auto_attribs=True, kw_only=True) +@define(auto_attribs=True, kw_only=True) class ExportCustomLabel(Base): title: str @@ -20,7 +21,7 @@ def client_class() -> type[ApiCustomLabel]: return ApiCustomLabel -@attr.s(auto_attribs=True, kw_only=True) +@define(auto_attribs=True, kw_only=True) class ExportCustomMetric(Base): title: str format: str @@ -30,7 +31,7 @@ def client_class() -> type[ApiCustomMetric]: return ApiCustomMetric -@attr.s(auto_attribs=True, kw_only=True) +@define(auto_attribs=True, kw_only=True) class ExportCustomOverride(Base): labels: Optional[dict[str, ExportCustomLabel]] = None metrics: Optional[dict[str, ExportCustomMetric]] = None @@ -40,7 +41,7 @@ def client_class() -> type[ApiCustomOverride]: return ApiCustomOverride -@attr.s(auto_attribs=True, kw_only=True) +@define(auto_attribs=True, kw_only=True) class ExportSettings(Base): merge_headers: bool show_filters: bool @@ -50,7 +51,7 @@ def client_class() -> type[ApiSettings]: return ApiSettings -@attr.s(auto_attribs=True, kw_only=True) +@define(auto_attribs=True, kw_only=True) class ExportRequest(Base): """ ExportRequest class is used to create an export request in the desired format, filename, and settings. @@ -96,3 +97,27 @@ def file(self) -> str: str: Full filename with the format extension. """ return f"{self.file_name}.{self.format.lower()}" + + +@define(auto_attribs=True, kw_only=True) +class VisualExportRequest(Base): + """ + ExportRequest class is used to create an export request in the desired format, filename, and settings. + Attributes: + dashboard_id (str): Dashboard identifier. + file_name (str): File name to be used for retrieving the PDF document. + metadata (Optional[Dict[str, bool]]): Optional dictionary containing settings for the export request. + """ + + dashboard_id: str + file_name: str + metadata: Optional[dict] = None + + @staticmethod + def client_class() -> type[VisualExportRequestApi]: + """ + Returns the appropriate client class for the visual export request. + Returns: + type[TabularExportRequest]: VisualExportRequest class + """ + return VisualExportRequestApi diff --git a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py index c30d1badd..a74e8d0b1 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py +++ b/gooddata-sdk/gooddata_sdk/catalog/organization/layout/notification_channel.py @@ -37,7 +37,7 @@ @define(auto_attribs=True, kw_only=True) class CatalogWebhook(Base): type: str = field(default="WEBHOOK", init=False) - url: Optional[str] = None + url: str token: Optional[str] = field(default=None, eq=False) has_token: Optional[bool] = field(default=None, eq=False) @@ -53,7 +53,7 @@ class CatalogDeclarativeNotificationChannel(Base): description: Optional[str] = None destination_type: Optional[str] = None custom_dashboard_url: Optional[str] = None - enable_multiple_recipients: Optional[bool] = None + allowed_recipients: Optional[str] = None # destination: Optional[Union[CatalogDefaultSmtp, CatalogSmtp, CatalogWebhook]] = None destination: Optional[CatalogWebhook] = None diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py index f48590ce0..5213a1f4a 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/automation.py @@ -3,11 +3,17 @@ from datetime import datetime from typing import Any, Optional -from attrs import define +from attrs import define, field from gooddata_api_client.model.automation_schedule import AutomationSchedule +from gooddata_api_client.model.automation_tabular_export import AutomationTabularExport +from gooddata_api_client.model.automation_visual_export import AutomationVisualExport from gooddata_api_client.model.declarative_automation import DeclarativeAutomation from gooddata_sdk.catalog.base import Base +from gooddata_sdk.catalog.export.request import ( + ExportRequest, + VisualExportRequest, +) from gooddata_sdk.catalog.identifier import ( CatalogExportDefinitionIdentifier, CatalogNotificationChannelIdentifier, @@ -19,15 +25,33 @@ @define(auto_attribs=True, kw_only=True) class CatalogAutomationSchedule(Base): cron: str - cron_description: Optional[str] = None + cron_description: Optional[str] = field(default=None, eq=False) first_run: Optional[datetime] = None - timezone: Optional[str] = None + timezone: Optional[str] = "UTC" @staticmethod def client_class() -> builtins.type[AutomationSchedule]: return AutomationSchedule +@define(auto_attribs=True, kw_only=True) +class CatalogAutomationTabularExport(Base): + request_payload: ExportRequest + + @staticmethod + def client_class() -> builtins.type[AutomationTabularExport]: + return AutomationTabularExport + + +@define(auto_attribs=True, kw_only=True) +class CatalogAutomationVisualExport(Base): + request_payload: VisualExportRequest + + @staticmethod + def client_class() -> builtins.type[AutomationVisualExport]: + return AutomationVisualExport + + @define(auto_attribs=True, kw_only=True) class CatalogDeclarativeAutomation(CatalogAnalyticsBaseMeta): description: Optional[str] = None @@ -36,10 +60,12 @@ class CatalogDeclarativeAutomation(CatalogAnalyticsBaseMeta): tags: Optional[list[str]] = None title: Optional[str] = None recipients: Optional[list[CatalogUserIdentifier]] = None - metadata: Optional[dict[str, Any]] = None + metadata: Optional[dict] = None export_definitions: Optional[CatalogExportDefinitionIdentifier] = None notification_channel: Optional[CatalogNotificationChannelIdentifier] = None schedule: Optional[CatalogAutomationSchedule] = None + tabular_exports: Optional[CatalogAutomationTabularExport] = None + visual_exports: Optional[CatalogAutomationVisualExport] = None @staticmethod def client_class() -> builtins.type[DeclarativeAutomation]: diff --git a/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py b/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py index 55bd910fd..dd6fb8172 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/workspace/service.py @@ -1246,7 +1246,7 @@ def get_declarative_automations(self, workspace_id: str) -> list[CatalogDeclarat List of declarative automations. """ return [ - CatalogDeclarativeAutomation.from_api(automation) + CatalogDeclarativeAutomation.from_dict(automation.to_dict()) for automation in self._layout_api.get_automations(workspace_id) ] diff --git a/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml b/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml index bc45c463a..e8de4f2bf 100644 --- a/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml +++ b/gooddata-sdk/tests/catalog/fixtures/organization/layout_notification_channels.yaml @@ -71,7 +71,7 @@ interactions: content-length: - '27' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:34:30 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 09:59:56 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: @@ -83,6 +83,8 @@ interactions: notificationChannels: - id: webhook name: Webhook + customDashboardUrl: https://dashboard.site + allowedRecipients: CREATOR destination: type: WEBHOOK url: https://webhook.site @@ -146,7 +148,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:34:30 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 09:59:56 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' @@ -217,19 +219,20 @@ interactions: X-XSS-Protection: - '0' content-length: - - '198' + - '242' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:34:30 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 09:59:56 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: notificationChannels: - - destination: + - allowedRecipients: CREATOR + customDashboardUrl: https://dashboard.site + destination: hasToken: true type: WEBHOOK url: https://webhook.site destinationType: WEBHOOK - enableMultipleRecipients: true id: webhook name: Webhook - request: @@ -296,7 +299,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:34:30 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 09:59:56 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' @@ -369,7 +372,7 @@ interactions: content-length: - '27' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:34:30 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 09:59:56 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: diff --git a/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml b/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml index 0f5f34581..c1281ba8d 100644 --- a/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml +++ b/gooddata-sdk/tests/catalog/fixtures/workspaces/layout_automations.yaml @@ -69,7 +69,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:11 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: [] @@ -143,7 +143,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' @@ -154,9 +154,14 @@ interactions: - id: automation state: ACTIVE title: Automation + metadata: + key: value notificationChannel: id: webhook type: notificationChannel + schedule: + cron: 0 0 * * * + timezone: UTC headers: Accept-Encoding: - br, gzip, deflate @@ -216,7 +221,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' @@ -287,16 +292,21 @@ interactions: X-XSS-Protection: - '0' content-length: - - '127' + - '203' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: - id: automation + metadata: + key: value notificationChannel: id: webhook type: notificationChannel + schedule: + cron: 0 0 * * * + timezone: UTC state: ACTIVE title: Automation - request: @@ -362,7 +372,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' @@ -433,7 +443,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: [] @@ -501,7 +511,7 @@ interactions: X-XSS-Protection: - '0' set-cookie: - - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 16 Oct 2024 10:37:12 GMT; + - SPRING_REDIRECT_URI=; Max-Age=0; Expires=Wed, 23 Oct 2024 11:21:42 GMT; Path=/; HTTPOnly; SameSite=Lax body: string: '' diff --git a/gooddata-sdk/tests/catalog/test_catalog_organization.py b/gooddata-sdk/tests/catalog/test_catalog_organization.py index 8a0d85d3d..02dcc2fcf 100644 --- a/gooddata-sdk/tests/catalog/test_catalog_organization.py +++ b/gooddata-sdk/tests/catalog/test_catalog_organization.py @@ -356,7 +356,11 @@ def test_layout_notification_channels(test_config): try: notification_channels_e = [ CatalogDeclarativeNotificationChannel( - id="webhook", name="Webhook", destination=CatalogWebhook(url="https://webhook.site", token="123") + id="webhook", + name="Webhook", + destination=CatalogWebhook(url="https://webhook.site", token="123"), + custom_dashboard_url="https://dashboard.site", + allowed_recipients="CREATOR", ), ] sdk.catalog_organization.put_declarative_notification_channels(notification_channels_e) @@ -364,13 +368,9 @@ def test_layout_notification_channels(test_config): assert notification_channels_e[0].id == notification_channels_o[0].id assert notification_channels_e[0].name == notification_channels_o[0].name assert notification_channels_e[0].destination == notification_channels_o[0].destination + assert notification_channels_e[0].custom_dashboard_url == notification_channels_o[0].custom_dashboard_url + assert notification_channels_e[0].allowed_recipients == notification_channels_o[0].allowed_recipients finally: sdk.catalog_organization.put_declarative_notification_channels([]) ncs = sdk.catalog_organization.get_declarative_notification_channels() assert len(ncs) == 0 - - -def test_prdel(): - CatalogDeclarativeNotificationChannel( - id="webhook", destination=CatalogWebhook(url="https://webhook.site", token="123") - ).to_api() diff --git a/gooddata-sdk/tests/catalog/test_catalog_workspace.py b/gooddata-sdk/tests/catalog/test_catalog_workspace.py index 5e3b7ed88..5228c384c 100644 --- a/gooddata-sdk/tests/catalog/test_catalog_workspace.py +++ b/gooddata-sdk/tests/catalog/test_catalog_workspace.py @@ -8,6 +8,7 @@ import yaml from gooddata_sdk import ( BasicCredentials, + CatalogAutomationSchedule, CatalogDataSourcePostgres, CatalogDeclarativeAutomation, CatalogDeclarativeUserDataFilter, @@ -946,6 +947,10 @@ def test_layout_automations(test_config): title="Automation", state="ACTIVE", notification_channel=CatalogNotificationChannelIdentifier(id="webhook"), + schedule=CatalogAutomationSchedule( + cron="0 0 * * *", + ), + metadata={"key": "value"}, ) ] sdk.catalog_workspace.put_declarative_automations(workspace_id, automations_expected) diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 6f8eb8c86..fdd732aca 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -657,6 +657,11 @@ "ChatHistoryInteraction": { "description": "List of chat history interactions.", "properties": { + "chatHistoryInteractionId": { + "description": "Chat History interaction ID. Unique ID for each interaction.", + "format": "int64", + "type": "integer" + }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, @@ -667,11 +672,6 @@ "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", "type": "boolean" }, - "interactionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "format": "int64", - "type": "integer" - }, "question": { "description": "User question", "maxLength": 2000, @@ -684,17 +684,16 @@ "description": "Text response for general questions.", "type": "string" }, - "threadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" } }, "required": [ + "chatHistoryInteractionId", "interactionFinished", - "interactionId", "question", - "routing", - "threadId" + "routing" ], "type": "object" }, @@ -705,14 +704,14 @@ "format": "int64", "type": "integer" }, - "chatHistoryThreadId": { - "description": "Chat History thread ID. Optional, backend can create it if not provided.", - "type": "string" - }, "reset": { "description": "User feedback.", "type": "boolean" }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" + }, "userFeedback": { "description": "User feedback.", "enum": [ @@ -742,10 +741,6 @@ }, "ChatRequest": { "properties": { - "chatHistoryThreadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", - "type": "string" - }, "limitCreate": { "default": 3, "description": "Maximum number of created results.", @@ -781,6 +776,10 @@ "format": "double", "type": "number" }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" + }, "titleToDescriptorRatio": { "default": 0.7, "description": "Temporary for experiments. Ratio of title score to descriptor score.", @@ -798,10 +797,6 @@ }, "ChatResult": { "properties": { - "chatHistoryThreadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", - "type": "string" - }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, @@ -814,6 +809,10 @@ "textResponse": { "description": "Text response for general questions.", "type": "string" + }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" } }, "required": [ @@ -1137,6 +1136,10 @@ "example": "country", "type": "string" }, + "title": { + "description": "Title of attribute.", + "type": "string" + }, "type": { "description": "Object type", "enum": [ @@ -1148,6 +1151,7 @@ }, "required": [ "id", + "title", "type" ], "type": "object" @@ -1995,6 +1999,10 @@ "example": "revenue", "type": "string" }, + "title": { + "description": "Title of metric.", + "type": "string" + }, "type": { "description": "Object type", "enum": [ @@ -2008,6 +2016,7 @@ }, "required": [ "id", + "title", "type" ], "type": "object" diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index 239416a8e..4b779583f 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -444,6 +444,21 @@ }, "AlertAfm": { "properties": { + "attributes": { + "description": "Attributes to be used in the computation.", + "items": { + "$ref": "#/components/schemas/AttributeItem" + }, + "maximum": 1, + "type": "array" + }, + "auxMeasures": { + "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items": { + "$ref": "#/components/schemas/MeasureItem" + }, + "type": "array" + }, "filters": { "description": "Various filter types to filter execution result.", "items": { @@ -886,6 +901,28 @@ ], "type": "object" }, + "AutomationTabularExport": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "AutomationVisualExport": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, "AvailableAssignees": { "properties": { "userGroups": { @@ -912,6 +949,11 @@ "ChatHistoryInteraction": { "description": "List of chat history interactions.", "properties": { + "chatHistoryInteractionId": { + "description": "Chat History interaction ID. Unique ID for each interaction.", + "format": "int64", + "type": "integer" + }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, @@ -922,11 +964,6 @@ "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", "type": "boolean" }, - "interactionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "format": "int64", - "type": "integer" - }, "question": { "description": "User question", "maxLength": 2000, @@ -939,17 +976,16 @@ "description": "Text response for general questions.", "type": "string" }, - "threadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" } }, "required": [ + "chatHistoryInteractionId", "interactionFinished", - "interactionId", "question", - "routing", - "threadId" + "routing" ], "type": "object" }, @@ -960,14 +996,14 @@ "format": "int64", "type": "integer" }, - "chatHistoryThreadId": { - "description": "Chat History thread ID. Optional, backend can create it if not provided.", - "type": "string" - }, "reset": { "description": "User feedback.", "type": "boolean" }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" + }, "userFeedback": { "description": "User feedback.", "enum": [ @@ -997,10 +1033,6 @@ }, "ChatRequest": { "properties": { - "chatHistoryThreadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", - "type": "string" - }, "limitCreate": { "default": 3, "description": "Maximum number of created results.", @@ -1036,6 +1068,10 @@ "format": "double", "type": "number" }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" + }, "titleToDescriptorRatio": { "default": 0.7, "description": "Temporary for experiments. Ratio of title score to descriptor score.", @@ -1053,10 +1089,6 @@ }, "ChatResult": { "properties": { - "chatHistoryThreadId": { - "description": "Chat History thread ID. Backend persists chat history and returns ID for further requests.", - "type": "string" - }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, @@ -1069,6 +1101,10 @@ "textResponse": { "description": "Text response for general questions.", "type": "string" + }, + "threadIdSuffix": { + "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type": "string" } }, "required": [ @@ -1154,6 +1190,47 @@ "ColumnLocation": { "type": "object" }, + "ColumnOverride": { + "description": "Table column override.", + "properties": { + "labelTargetColumn": { + "description": "Specifies the attribute's column to which this label is associated.", + "example": "users", + "type": "string" + }, + "labelType": { + "description": "Label type for the target attribute.", + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "IMAGE" + ], + "example": "HYPERLINK", + "type": "string" + }, + "ldmTypeOverride": { + "description": "Logical Data Model type for the column.", + "enum": [ + "FACT", + "LABEL" + ], + "example": "FACT", + "type": "string" + }, + "name": { + "description": "Column name.", + "example": "column_name", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "ColumnStatistic": { "properties": { "type": { @@ -1879,6 +1956,30 @@ ], "type": "object" }, + "DeclarativeAnalyticalDashboardIdentifier": { + "description": "An analytical dashboard identifier.", + "properties": { + "id": { + "description": "Identifier of the analytical dashboard.", + "example": "dashboard123", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type.", + "enum": [ + "analyticalDashboard" + ], + "example": "analyticalDashboard", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, "DeclarativeAnalyticalDashboardPermissionAssignment": { "description": "Analytical dashboard permission.", "properties": { @@ -2164,6 +2265,9 @@ }, "DeclarativeAutomation": { "properties": { + "analyticalDashboard": { + "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", @@ -2234,6 +2338,13 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "$ref": "#/components/schemas/AutomationTabularExport" + }, + "type": "array", + "uniqueItems": true + }, "tags": { "items": { "description": "A list of tags.", @@ -2246,6 +2357,13 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "$ref": "#/components/schemas/AutomationVisualExport" + }, + "type": "array", + "uniqueItems": true } }, "required": [ @@ -3006,6 +3124,51 @@ ], "type": "object" }, + "DeclarativeFilterView": { + "properties": { + "analyticalDashboard": { + "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "maxLength": 255, + "type": "string" + }, + "id": { + "description": "FilterView object ID.", + "example": "filterView-1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "isDefault": { + "description": "Indicator whether the filter view should by applied by default.", + "type": "boolean" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"Revenue\",\"Sales\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + } + }, + "required": [ + "id", + "title" + ], + "type": "object" + }, "DeclarativeJwk": { "description": "A declarative form of the JWK.", "properties": { @@ -3212,6 +3375,15 @@ "DeclarativeNotificationChannel": { "description": "A declarative form of a particular notification channel.", "properties": { + "allowedRecipients": { + "default": "INTERNAL", + "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\n", + "enum": [ + "CREATOR", + "INTERNAL" + ], + "type": "string" + }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}.", "type": "string" @@ -3245,11 +3417,6 @@ "readOnly": true, "type": "string" }, - "enableMultipleRecipients": { - "default": true, - "description": "Whether notifications sent to the channel can have multiple recipients.", - "type": "boolean" - }, "id": { "description": "Identifier of a notification channel", "example": "notification-channel-1", @@ -3425,6 +3592,16 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -3673,7 +3850,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "example": "TIMEZONE", "type": "string" @@ -4234,6 +4412,12 @@ "type": "array", "uniqueItems": true }, + "filterViews": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + }, "hierarchyPermissions": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" @@ -4717,6 +4901,10 @@ "example": "country", "type": "string" }, + "title": { + "description": "Title of attribute.", + "type": "string" + }, "type": { "description": "Object type", "enum": [ @@ -4728,6 +4916,7 @@ }, "required": [ "id", + "title", "type" ], "type": "object" @@ -5528,6 +5717,7 @@ "type": "string" }, "generateLongIds": { + "default": false, "description": "A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.", "type": "boolean" }, @@ -5572,7 +5762,6 @@ "separator": { "default": "__", "description": "A separator between prefixes and the names. Default is \"__\".", - "example": "__", "type": "string" }, "tablePrefix": { @@ -5588,8 +5777,8 @@ "type": "string" }, "wdfPrefix": { + "default": "wdf", "description": "Column serving as workspace data filter. No labels are auto generated for such columns.", - "example": "wdf", "type": "string" }, "workspaceId": { @@ -7293,6 +7482,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -7302,6 +7505,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -7499,6 +7716,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -7508,6 +7739,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -7801,6 +8046,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -7810,6 +8069,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -13753,6 +14026,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -13865,6 +14146,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -14028,6 +14317,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -14105,7 +14402,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -14170,7 +14468,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -14275,7 +14574,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -15746,7 +16046,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -15811,7 +16112,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -17553,7 +17855,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -17618,7 +17921,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -17749,7 +18053,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -17814,7 +18119,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -18190,6 +18496,10 @@ "example": "revenue", "type": "string" }, + "title": { + "description": "Title of metric.", + "type": "string" + }, "type": { "description": "Object type", "enum": [ @@ -18203,6 +18513,7 @@ }, "required": [ "id", + "title", "type" ], "type": "object" @@ -18536,6 +18847,13 @@ }, "type": "array" }, + "tableOverrides": { + "description": "(BETA) List of table overrides.", + "items": { + "$ref": "#/components/schemas/TableOverride" + }, + "type": "array" + }, "tables": { "description": "List of physical database tables.", "items": { @@ -19103,7 +19421,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "example": "TIMEZONE", "type": "string" @@ -20004,6 +20323,34 @@ ], "type": "object" }, + "TableOverride": { + "description": "Table override settings.", + "properties": { + "columns": { + "description": "An array of column overrides", + "items": { + "$ref": "#/components/schemas/ColumnOverride" + }, + "type": "array" + }, + "path": { + "description": "Path for the table.", + "example": [ + "schema", + "table_name" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "columns", + "path" + ], + "type": "object" + }, "TableWarning": { "description": "Warnings related to single table.", "properties": { @@ -39019,6 +39366,106 @@ } } }, + "/api/v1/layout/workspaces/{workspaceId}/filterViews": { + "get": { + "description": "Retrieve filter views for the specific workspace", + "operationId": "getFilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "description": "Defines properties which should not be included in the payload.", + "enum": [ + "ACTIVITY_INFO" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + } + } + }, + "description": "Retrieved filterViews." + } + }, + "summary": "Get filter views", + "tags": [ + "layout", + "Filter Views" + ], + "x-gdc-security-info": { + "description": "Permissions to read the filter views.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "Set filter views for the specific workspace.", + "operationId": "setFilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "FilterViews successfully set." + } + }, + "summary": "Set filter views", + "tags": [ + "layout", + "Filter Views" + ], + "x-gdc-security-info": { + "description": "Permissions to modify the filter views.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/layout/workspaces/{workspaceId}/logicalModel": { "get": { "description": "Retrieve current logical model of the workspace in declarative form.", diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 8c6f92288..8e64bde8e 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -253,8 +253,18 @@ "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" + }, + "type": { + "enum": [ + "label" + ], + "type": "string" } }, + "required": [ + "type", + "id" + ], "type": "object" } }, @@ -265,6 +275,21 @@ }, "AlertAfm": { "properties": { + "attributes": { + "description": "Attributes to be used in the computation.", + "items": { + "$ref": "#/components/schemas/AttributeItem" + }, + "maximum": 1, + "type": "array" + }, + "auxMeasures": { + "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items": { + "$ref": "#/components/schemas/MeasureItem" + }, + "type": "array" + }, "filters": { "description": "Various filter types to filter execution result.", "items": { @@ -490,6 +515,27 @@ ], "type": "object" }, + "AttributeItem": { + "properties": { + "label": { + "$ref": "#/components/schemas/AfmObjectIdentifierLabel" + }, + "localIdentifier": { + "pattern": "^[.a-zA-Z0-9_-]+$", + "type": "string" + }, + "showAllValues": { + "default": false, + "description": "Specifies that the label should be outer-joined.", + "type": "boolean" + } + }, + "required": [ + "label", + "localIdentifier" + ], + "type": "object" + }, "AutomationSchedule": { "properties": { "cron": { @@ -521,6 +567,28 @@ ], "type": "object" }, + "AutomationTabularExport": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "AutomationVisualExport": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, "AvailableAssignees": { "properties": { "userGroups": { @@ -544,6 +612,47 @@ ], "type": "object" }, + "ColumnOverride": { + "description": "Table column override.", + "properties": { + "labelTargetColumn": { + "description": "Specifies the attribute's column to which this label is associated.", + "example": "users", + "type": "string" + }, + "labelType": { + "description": "Label type for the target attribute.", + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "IMAGE" + ], + "example": "HYPERLINK", + "type": "string" + }, + "ldmTypeOverride": { + "description": "Logical Data Model type for the column.", + "enum": [ + "FACT", + "LABEL" + ], + "example": "FACT", + "type": "string" + }, + "name": { + "description": "Column name.", + "example": "column_name", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "Comparison": { "properties": { "left": { @@ -989,6 +1098,30 @@ ], "type": "object" }, + "DeclarativeAnalyticalDashboardIdentifier": { + "description": "An analytical dashboard identifier.", + "properties": { + "id": { + "description": "Identifier of the analytical dashboard.", + "example": "dashboard123", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type.", + "enum": [ + "analyticalDashboard" + ], + "example": "analyticalDashboard", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, "DeclarativeAnalyticalDashboardPermissionAssignment": { "description": "Analytical dashboard permission.", "properties": { @@ -1274,6 +1407,9 @@ }, "DeclarativeAutomation": { "properties": { + "analyticalDashboard": { + "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", @@ -1344,6 +1480,13 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "$ref": "#/components/schemas/AutomationTabularExport" + }, + "type": "array", + "uniqueItems": true + }, "tags": { "items": { "description": "A list of tags.", @@ -1356,6 +1499,13 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "$ref": "#/components/schemas/AutomationVisualExport" + }, + "type": "array", + "uniqueItems": true } }, "required": [ @@ -2117,6 +2267,51 @@ ], "type": "object" }, + "DeclarativeFilterView": { + "properties": { + "analyticalDashboard": { + "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "maxLength": 255, + "type": "string" + }, + "id": { + "description": "FilterView object ID.", + "example": "filterView-1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "isDefault": { + "description": "Indicator whether the filter view should by applied by default.", + "type": "boolean" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"Revenue\",\"Sales\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + } + }, + "required": [ + "id", + "title" + ], + "type": "object" + }, "DeclarativeJwk": { "description": "A declarative form of the JWK.", "properties": { @@ -2323,6 +2518,15 @@ "DeclarativeNotificationChannel": { "description": "A declarative form of a particular notification channel.", "properties": { + "allowedRecipients": { + "default": "INTERNAL", + "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\n", + "enum": [ + "CREATOR", + "INTERNAL" + ], + "type": "string" + }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are {workspaceId}, {dashboardId}.", "type": "string" @@ -2356,11 +2560,6 @@ "readOnly": true, "type": "string" }, - "enableMultipleRecipients": { - "default": true, - "description": "Whether notifications sent to the channel can have multiple recipients.", - "type": "boolean" - }, "id": { "description": "Identifier of a notification channel", "example": "notification-channel-1", @@ -2536,6 +2735,16 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -2784,7 +2993,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "example": "TIMEZONE", "type": "string" @@ -3329,6 +3539,12 @@ "type": "array", "uniqueItems": true }, + "filterViews": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + }, "hierarchyPermissions": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" @@ -3988,6 +4204,7 @@ "type": "string" }, "generateLongIds": { + "default": false, "description": "A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.", "type": "boolean" }, @@ -4032,7 +4249,6 @@ "separator": { "default": "__", "description": "A separator between prefixes and the names. Default is \"__\".", - "example": "__", "type": "string" }, "tablePrefix": { @@ -4048,8 +4264,8 @@ "type": "string" }, "wdfPrefix": { + "default": "wdf", "description": "Column serving as workspace data filter. No labels are auto generated for such columns.", - "example": "wdf", "type": "string" }, "workspaceId": { @@ -5689,6 +5905,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -5698,6 +5928,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -5895,6 +6139,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -5904,6 +6162,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -6197,6 +6469,20 @@ ], "type": "string" }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, "tags": { "items": { "type": "string" @@ -6206,6 +6492,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" } }, "type": "object" @@ -12149,6 +12449,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -12261,6 +12569,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -12424,6 +12740,14 @@ "maxLength": 255, "type": "string" }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", @@ -12501,7 +12825,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -12566,7 +12891,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -12671,7 +12997,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -14142,7 +14469,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -14207,7 +14535,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -15949,7 +16278,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -16014,7 +16344,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -16145,7 +16476,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -16210,7 +16542,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "type": "string" } @@ -16688,6 +17021,13 @@ }, "type": "array" }, + "tableOverrides": { + "description": "(BETA) List of table overrides.", + "items": { + "$ref": "#/components/schemas/TableOverride" + }, + "type": "array" + }, "tables": { "description": "List of physical database tables.", "items": { @@ -17255,7 +17595,8 @@ "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", - "ALERT" + "ALERT", + "SEPARATORS" ], "example": "TIMEZONE", "type": "string" @@ -17558,6 +17899,34 @@ ], "type": "object" }, + "TableOverride": { + "description": "Table override settings.", + "properties": { + "columns": { + "description": "An array of column overrides", + "items": { + "$ref": "#/components/schemas/ColumnOverride" + }, + "type": "array" + }, + "path": { + "description": "Path for the table.", + "example": [ + "schema", + "table_name" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "columns", + "path" + ], + "type": "object" + }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { @@ -34405,6 +34774,106 @@ } } }, + "/api/v1/layout/workspaces/{workspaceId}/filterViews": { + "get": { + "description": "Retrieve filter views for the specific workspace", + "operationId": "getFilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "description": "Defines properties which should not be included in the payload.", + "enum": [ + "ACTIVITY_INFO" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + } + } + }, + "description": "Retrieved filterViews." + } + }, + "summary": "Get filter views", + "tags": [ + "layout", + "Filter Views" + ], + "x-gdc-security-info": { + "description": "Permissions to read the filter views.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "Set filter views for the specific workspace.", + "operationId": "setFilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/DeclarativeFilterView" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "FilterViews successfully set." + } + }, + "summary": "Set filter views", + "tags": [ + "layout", + "Filter Views" + ], + "x-gdc-security-info": { + "description": "Permissions to modify the filter views.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/layout/workspaces/{workspaceId}/logicalModel": { "get": { "description": "Retrieve current logical model of the workspace in declarative form.",