From b6f29599f3dafd1864dbb66166347a92965da327 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Pe=C5=88=C3=A1z?= Date: Wed, 18 Nov 2026 15:24:19 +0100 Subject: [PATCH] fix(gooddata-sdk): keep template authors through put (#1958) * chore(gooddata-api-client): regenerate against staging A declarative put of document templates and page templates makes the caller their creator, because the client has no author fields on either template schema and the SDK cannot send them. The backend has exposed and restored createdBy, createdAt, modifiedBy and modifiedAt on both since LX-3490. Regenerating from the staging spec gives DeclarativePublisherDocumentTemplate and DeclarativePublisherDocumentPageTemplate the four fields, typed as on DeclarativePublisherDocument, ready for the SDK to model. The spec is taken whole, so the regeneration also brings in drift that nothing in the SDK models yet: - metricExtensions and visualizationObjectExtensions on the analytics layer (DeclarativeMetricExtension, DeclarativeVisualizationObjectExtension); - a DATE_RANGE parameter type (DateRangeParameterDefinition, DateRangeParameterValue, ParameterizedDateFilter) and a nullable bound on RelativeBoundedDateFilter. The generator flattens a oneOf into its last member, so the composed ParameterDefinition and JsonApiParameterInAttributesDefinition models now default to DATE_RANGE with a DateRangeParameterValue default_value instead of STRING with a str; - DeclarativeMetricPermissionAssignment and DeclarativeVisualizationObjectPermissionAssignment are no longer nullable; - localization issues, per-workspace coverage statistics (includeCoverage, LocalizationMetadataStatistics.workspaces) and child-workspace usage, with their new paths; - a GOODDATA_AI LLM provider config (GoodDataAiProviderConfig); - embedding-origin validation (validateEmbeddingOrigin and the EMBEDDING_ORIGINS setting), plus the ENABLE_AI_TRACE_OBFUSCATION, ENABLE_AI_PERSISTENCE_OBFUSCATION and AI_LAKE_CREDENTIAL_VENDING settings; - a computation profile on result cache metadata, an AFM execution progress stream, an AI Lake data source refresh operation and a workspace document search path. No path, schema, property or API tag is removed or renamed, and no field that was a free-form object gained a type. Nothing in the SDK uses the parameter definition or permission assignment models above. The SDK passes type-check and its suite unchanged, and so does gooddata-pipelines. jira: LX-3539 risk: low Co-Authored-By: Claude Opus 5.5 * fix(gooddata-sdk): keep template authors through put Document templates and page templates had no author fields in the SDK model, so a declarative get dropped createdBy, createdAt, modifiedBy and modifiedAt and a put sent none. The backend then stamped the caller as creator of every template, which a workspace backup and restore turned into the restoring admin and the time of the restore. Both template classes now share the analytics base documents already use, so the four optional fields are read, stored to the template's layout file, loaded and put back. A template without them still loads with them empty, and a put without them still makes the caller the creator. The backend has restored template authors from the payload since LX-3490. gdc deploy is unchanged: the Analytics-as-Code form carries no author fields for any object type, so a deploy makes the deployer the creator by design. The round-trip seed gives both templates a non-caller author so a reset to the caller fails the test. Its cassette is re-recorded separately. jira: LX-3539 risk: low Co-Authored-By: Claude Sonnet 5.5 * chore(gooddata-sdk): re-record template author cassette The round-trip test now seeds a document template and a page template authored by demo rather than the calling admin, and asserts all four author fields on both after get, store, load and put. The old cassette was recorded when templates had no author fields, so the backend had stamped admin as their creator. Re-recorded on python-sdk-dex, which runs the backend change that restores template authors from the layout payload. The recorded responses carry createdBy, createdAt, modifiedBy and modifiedAt on both templates, with demo as creator. No other cassette changes. jira: LX-3539 risk: nonprod Co-Authored-By: Claude Sonnet 5.5 --------- Co-authored-by: Claude Opus 5.5 --- gooddata-api-client/.openapi-generator/FILES | 34 + gooddata-api-client/README.md | 262 ++-- gooddata-api-client/docs/AILakeApi.md | 78 ++ .../docs/AILakeDatabasesApi.md | 78 ++ .../docs/AbsoluteGranularityDateFilter.md | 2 +- gooddata-api-client/docs/ActionsApi.md | 567 +++++++- .../docs/AggregatedFactControllerApi.md | 8 +- .../docs/AnalyticalDashboardControllerApi.md | 8 +- gooddata-api-client/docs/AnalyticsModelApi.md | 36 + .../docs/AttributeControllerApi.md | 16 +- .../docs/AttributeHierarchiesApi.md | 8 +- .../docs/AttributeHierarchyControllerApi.md | 8 +- gooddata-api-client/docs/AttributesApi.md | 16 +- .../docs/AutomationControllerApi.md | 8 +- .../docs/AutomationResultControllerApi.md | 8 +- gooddata-api-client/docs/AutomationsApi.md | 16 +- gooddata-api-client/docs/ComputationApi.md | 69 + .../docs/ComputationProfile.md | 19 + .../docs/ComputationProfileSource.md | 23 + .../docs/ComputedAttributeControllerApi.md | 8 +- .../docs/ComputedAttributesApi.md | 8 +- .../CustomApplicationSettingControllerApi.md | 8 +- .../docs/DashboardPluginControllerApi.md | 8 +- gooddata-api-client/docs/DashboardsApi.md | 8 +- gooddata-api-client/docs/DataFiltersApi.md | 24 +- .../docs/DatasetControllerApi.md | 16 +- gooddata-api-client/docs/DatasetsApi.md | 16 +- gooddata-api-client/docs/DateFilter.md | 1 + .../docs/DateRangeParameterDefinition.md | 13 + .../docs/DateRangeParameterValue.md | 14 + .../docs/DeclarativeAnalyticsLayer.md | 2 + .../docs/DeclarativeMetricExtension.md | 13 + ...eclarativePublisherDocumentPageTemplate.md | 4 + .../DeclarativePublisherDocumentTemplate.md | 4 + ...DeclarativeVisualizationObjectExtension.md | 13 + .../docs/DocumentControllerApi.md | 100 ++ gooddata-api-client/docs/EntitiesApi.md | 324 +++-- .../docs/ExportDefinitionControllerApi.md | 8 +- .../docs/ExportDefinitionsApi.md | 8 +- gooddata-api-client/docs/FactControllerApi.md | 16 +- gooddata-api-client/docs/FactsApi.md | 24 +- gooddata-api-client/docs/FailedOperation.md | 2 +- gooddata-api-client/docs/FilterContextApi.md | 8 +- .../docs/FilterContextControllerApi.md | 8 +- gooddata-api-client/docs/FilterDefinition.md | 1 + .../docs/FilterDefinitionForSimpleMeasure.md | 1 + .../docs/FilterViewControllerApi.md | 8 +- gooddata-api-client/docs/FilterViewsApi.md | 8 +- .../docs/GetAiLakeOperation200Response.md | 2 +- .../docs/GoodDataAiProviderConfig.md | 13 + ...piLlmProviderInAttributesProviderConfig.md | 2 +- .../JsonApiParameterInAttributesDefinition.md | 4 +- .../KnowledgeRecommendationControllerApi.md | 8 +- .../docs/KnowledgeRecommendationsApi.md | 8 +- .../docs/LabelControllerApi.md | 16 +- gooddata-api-client/docs/LabelsApi.md | 16 +- gooddata-api-client/docs/LayoutApi.md | 144 ++ gooddata-api-client/docs/LocalizationApi.md | 375 ++++- gooddata-api-client/docs/LocalizationIssue.md | 15 + .../docs/LocalizationIssueWorkspace.md | 16 + .../docs/LocalizationIssueWorkspaces.md | 13 + .../docs/LocalizationIssues.md | 12 + .../docs/LocalizationMetadataStatistics.md | 1 + .../docs/LocalizationSettingUsage.md | 2 + .../LocalizationStatisticsTranslatedLocale.md | 14 + .../docs/LocalizationStatisticsWorkspace.md | 17 + .../docs/LocalizationUsageValue.md | 3 +- .../docs/MemoryItemControllerApi.md | 8 +- gooddata-api-client/docs/MemoryItemsApi.md | 8 +- .../docs/MetricControllerApi.md | 8 +- gooddata-api-client/docs/MetricsApi.md | 8 +- gooddata-api-client/docs/Operation.md | 2 +- .../docs/OrganizationDeclarativeAPIsApi.md | 36 + .../docs/ParameterControllerApi.md | 8 +- .../docs/ParameterDefinition.md | 4 +- .../docs/ParameterizedDateFilter.md | 13 + ...erizedDateFilterParameterizedDateFilter.md | 16 + gooddata-api-client/docs/ParametersApi.md | 8 +- gooddata-api-client/docs/PendingOperation.md | 2 +- gooddata-api-client/docs/PermissionsApi.md | 36 +- gooddata-api-client/docs/PluginsApi.md | 8 +- .../docs/PublisherDocumentWidgetTitle.md | 2 +- .../docs/PublisherDocumentsApi.md | 100 ++ gooddata-api-client/docs/RawExportApi.md | 16 +- .../docs/RelativeBoundedDateFilter.md | 4 +- .../docs/ReportingSettingsApi.md | 71 + .../docs/ResultCacheMetadata.md | 1 + .../docs/SucceededOperation.md | 2 +- .../docs/UserDataFilterControllerApi.md | 8 +- .../docs/ValidateEmbeddingOriginRequest.md | 13 + .../docs/ValidateEmbeddingOriginResponse.md | 13 + .../docs/VisualizationObjectApi.md | 8 +- .../docs/VisualizationObjectControllerApi.md | 8 +- .../docs/WorkspaceDataFilterControllerApi.md | 8 +- ...WorkspaceDataFilterSettingControllerApi.md | 8 +- .../docs/WorkspaceSettingControllerApi.md | 8 +- .../docs/WorkspacesDeclarativeAPIsApi.md | 72 + .../docs/WorkspacesSettingsApi.md | 16 +- .../gooddata_api_client/api/actions_api.py | 986 ++++++++++++- .../api/aggregated_fact_controller_api.py | 2 +- .../gooddata_api_client/api/ai_lake_api.py | 146 ++ .../api/ai_lake_databases_api.py | 146 ++ .../analytical_dashboard_controller_api.py | 2 +- .../api/attribute_controller_api.py | 4 +- .../api/attribute_hierarchies_api.py | 2 +- .../api/attribute_hierarchy_controller_api.py | 2 +- .../gooddata_api_client/api/attributes_api.py | 4 +- .../api/automation_controller_api.py | 2 +- .../api/automation_result_controller_api.py | 2 +- .../api/automations_api.py | 4 +- .../api/computation_api.py | 149 ++ .../api/computed_attribute_controller_api.py | 2 +- .../api/computed_attributes_api.py | 2 +- ...stom_application_setting_controller_api.py | 2 +- .../api/dashboard_plugin_controller_api.py | 2 +- .../gooddata_api_client/api/dashboards_api.py | 2 +- .../api/data_filters_api.py | 6 +- .../api/dataset_controller_api.py | 4 +- .../gooddata_api_client/api/datasets_api.py | 4 +- .../api/document_controller_api.py | 163 +++ .../gooddata_api_client/api/entities_api.py | 218 ++- .../api/export_definition_controller_api.py | 2 +- .../api/export_definitions_api.py | 2 +- .../api/fact_controller_api.py | 4 +- .../gooddata_api_client/api/facts_api.py | 6 +- .../api/filter_context_api.py | 2 +- .../api/filter_context_controller_api.py | 2 +- .../api/filter_view_controller_api.py | 2 +- .../api/filter_views_api.py | 2 +- ...knowledge_recommendation_controller_api.py | 2 +- .../api/knowledge_recommendations_api.py | 2 +- .../api/label_controller_api.py | 4 +- .../gooddata_api_client/api/labels_api.py | 4 +- .../api/localization_api.py | 672 ++++++++- .../api/memory_item_controller_api.py | 2 +- .../api/memory_items_api.py | 2 +- .../api/metric_controller_api.py | 2 +- .../gooddata_api_client/api/metrics_api.py | 2 +- .../api/parameter_controller_api.py | 2 +- .../gooddata_api_client/api/parameters_api.py | 2 +- .../api/permissions_api.py | 12 +- .../gooddata_api_client/api/plugins_api.py | 2 +- .../api/publisher_documents_api.py | 163 +++ .../gooddata_api_client/api/raw_export_api.py | 8 +- .../api/reporting_settings_api.py | 135 ++ .../api/user_data_filter_controller_api.py | 2 +- .../api/visualization_object_api.py | 2 +- .../visualization_object_controller_api.py | 2 +- .../workspace_data_filter_controller_api.py | 2 +- ...pace_data_filter_setting_controller_api.py | 2 +- .../api/workspace_setting_controller_api.py | 2 +- .../api/workspaces_settings_api.py | 4 +- .../model/computation_profile.py | 304 ++++ .../model/computation_profile_source.py | 308 +++++ .../gooddata_api_client/model/date_filter.py | 9 + .../model/date_range_parameter_definition.py | 287 ++++ .../model/date_range_parameter_value.py | 288 ++++ .../model/declarative_analytics_layer.py | 12 + .../model/declarative_metric_extension.py | 287 ++++ ...eclarative_metric_permission_assignment.py | 2 +- ...rative_publisher_document_page_template.py | 28 + ...declarative_publisher_document_template.py | 28 + .../model/declarative_setting.py | 4 + ...larative_visualization_object_extension.py | 287 ++++ ...ualization_object_permission_assignment.py | 2 +- .../model/failed_operation.py | 5 +- .../model/filter_definition.py | 9 + .../filter_definition_for_simple_measure.py | 6 + .../get_ai_lake_operation200_response.py | 5 +- .../model/good_data_ai_provider_config.py | 275 ++++ ..._provider_in_attributes_provider_config.py | 9 +- ..._api_organization_setting_in_attributes.py | 4 + ..._api_parameter_in_attributes_definition.py | 23 +- .../json_api_user_setting_in_attributes.py | 2 + .../model/llm_provider_config.py | 3 + .../model/localization_issue.py | 285 ++++ .../model/localization_issue_workspace.py | 298 ++++ .../model/localization_issue_workspaces.py | 282 ++++ .../model/localization_issues.py | 276 ++++ .../model/localization_metadata_statistics.py | 6 + .../model/localization_setting_usage.py | 4 + ...calization_statistics_translated_locale.py | 276 ++++ .../localization_statistics_workspace.py | 298 ++++ .../model/localization_usage_value.py | 4 + .../gooddata_api_client/model/operation.py | 5 +- .../model/parameter_definition.py | 23 +- .../model/parameterized_date_filter.py | 276 ++++ ...d_date_filter_parameterized_date_filter.py | 301 ++++ .../model/pending_operation.py | 5 +- .../model/publisher_document_widget_title.py | 4 +- .../model/relative_bounded_date_filter.py | 12 +- .../model/resolved_setting.py | 3 + .../model/result_cache_metadata.py | 6 + .../model/succeeded_operation.py | 5 +- .../validate_embedding_origin_request.py | 270 ++++ .../validate_embedding_origin_response.py | 270 ++++ .../gooddata_api_client/models/__init__.py | 17 + .../analytics_model/analytics_model.py | 4 +- ...declarative_analytics_model_documents.json | 8 + .../demo_documents_store_load_and_put.yaml | 88 +- .../catalog/test_catalog_workspace_content.py | 10 + .../test_declarative_analytics_documents.py | 70 +- schemas/gooddata-afm-client.json | 289 +++- schemas/gooddata-api-client.json | 1229 ++++++++++++++++- schemas/gooddata-automation-client.json | 50 +- schemas/gooddata-export-client.json | 58 +- schemas/gooddata-metadata-client.json | 996 ++++++++++++- 207 files changed, 13031 insertions(+), 938 deletions(-) create mode 100644 gooddata-api-client/docs/ComputationProfile.md create mode 100644 gooddata-api-client/docs/ComputationProfileSource.md create mode 100644 gooddata-api-client/docs/DateRangeParameterDefinition.md create mode 100644 gooddata-api-client/docs/DateRangeParameterValue.md create mode 100644 gooddata-api-client/docs/DeclarativeMetricExtension.md create mode 100644 gooddata-api-client/docs/DeclarativeVisualizationObjectExtension.md create mode 100644 gooddata-api-client/docs/GoodDataAiProviderConfig.md create mode 100644 gooddata-api-client/docs/LocalizationIssue.md create mode 100644 gooddata-api-client/docs/LocalizationIssueWorkspace.md create mode 100644 gooddata-api-client/docs/LocalizationIssueWorkspaces.md create mode 100644 gooddata-api-client/docs/LocalizationIssues.md create mode 100644 gooddata-api-client/docs/LocalizationStatisticsTranslatedLocale.md create mode 100644 gooddata-api-client/docs/LocalizationStatisticsWorkspace.md create mode 100644 gooddata-api-client/docs/ParameterizedDateFilter.md create mode 100644 gooddata-api-client/docs/ParameterizedDateFilterParameterizedDateFilter.md create mode 100644 gooddata-api-client/docs/ValidateEmbeddingOriginRequest.md create mode 100644 gooddata-api-client/docs/ValidateEmbeddingOriginResponse.md create mode 100644 gooddata-api-client/gooddata_api_client/model/computation_profile.py create mode 100644 gooddata-api-client/gooddata_api_client/model/computation_profile_source.py create mode 100644 gooddata-api-client/gooddata_api_client/model/date_range_parameter_definition.py create mode 100644 gooddata-api-client/gooddata_api_client/model/date_range_parameter_value.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_metric_extension.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_extension.py create mode 100644 gooddata-api-client/gooddata_api_client/model/good_data_ai_provider_config.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_issue.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_issue_workspace.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_issue_workspaces.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_issues.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_statistics_translated_locale.py create mode 100644 gooddata-api-client/gooddata_api_client/model/localization_statistics_workspace.py create mode 100644 gooddata-api-client/gooddata_api_client/model/parameterized_date_filter.py create mode 100644 gooddata-api-client/gooddata_api_client/model/parameterized_date_filter_parameterized_date_filter.py create mode 100644 gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_request.py create mode 100644 gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_response.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 1cf55578c..8479a6719 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -168,6 +168,8 @@ docs/ComparisonWrapper.md docs/CompoundMeasureValueFilter.md docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md docs/ComputationApi.md +docs/ComputationProfile.md +docs/ComputationProfileSource.md docs/ComputedAttributeControllerApi.md docs/ComputedAttributePermissions.md docs/ComputedAttributePermissionsAssignment.md @@ -268,6 +270,8 @@ docs/DatasetReferenceIdentifier.md docs/DatasetWorkspaceDataFilterIdentifier.md docs/DatasetsApi.md docs/DateFilter.md +docs/DateRangeParameterDefinition.md +docs/DateRangeParameterValue.md docs/DateValue.md docs/DeclarativeAgent.md docs/DeclarativeAgents.md @@ -320,6 +324,7 @@ docs/DeclarativeLabelTranslation.md docs/DeclarativeLdm.md docs/DeclarativeMemoryItem.md docs/DeclarativeMetric.md +docs/DeclarativeMetricExtension.md docs/DeclarativeMetricPermissionAssignment.md docs/DeclarativeMetricPermissionForAssignee.md docs/DeclarativeMetricPermissionForAssigneeRule.md @@ -361,6 +366,7 @@ docs/DeclarativeUserPermissions.md docs/DeclarativeUsers.md docs/DeclarativeUsersUserGroups.md docs/DeclarativeVisualizationObject.md +docs/DeclarativeVisualizationObjectExtension.md docs/DeclarativeVisualizationObjectPermissionAssignment.md docs/DeclarativeVisualizationObjectPermissionForAssignee.md docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md @@ -485,6 +491,7 @@ docs/GetAiLakeOperation200Response.md docs/GetDocumentExport202ResponseInner.md docs/GetQualityIssuesResponse.md docs/GetServiceStatusResponse.md +docs/GoodDataAiProviderConfig.md docs/GrainIdentifier.md docs/GrantedPermission.md docs/GranularitiesFormatting.md @@ -1360,6 +1367,10 @@ docs/LocalizationCount.md docs/LocalizationDataStatistics.md docs/LocalizationDefault.md docs/LocalizationDefaults.md +docs/LocalizationIssue.md +docs/LocalizationIssueWorkspace.md +docs/LocalizationIssueWorkspaces.md +docs/LocalizationIssues.md docs/LocalizationMetadataStatistics.md docs/LocalizationResolvedValue.md docs/LocalizationResolvedValues.md @@ -1368,6 +1379,8 @@ docs/LocalizationSettingUsages.md docs/LocalizationSourceCounts.md docs/LocalizationStatistics.md docs/LocalizationStatisticsLocale.md +docs/LocalizationStatisticsTranslatedLocale.md +docs/LocalizationStatisticsWorkspace.md docs/LocalizationUsage.md docs/LocalizationUsageUser.md docs/LocalizationUsageUsers.md @@ -1466,6 +1479,8 @@ docs/ParameterControllerApi.md docs/ParameterDefinition.md docs/ParameterItem.md docs/ParameterValue.md +docs/ParameterizedDateFilter.md +docs/ParameterizedDateFilterParameterizedDateFilter.md docs/ParametersApi.md docs/PdfTableStyle.md docs/PdfTableStyleProperty.md @@ -1722,6 +1737,8 @@ docs/UserSettingsApi.md docs/UsersDeclarativeAPIsApi.md docs/UsersEntityAPIsApi.md docs/ValidateByItem.md +docs/ValidateEmbeddingOriginRequest.md +docs/ValidateEmbeddingOriginResponse.md docs/ValidityPeriodCacheRetention.md docs/Value.md docs/VisibleFilter.md @@ -2070,6 +2087,8 @@ gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_val gooddata_api_client/model/comparison_wrapper.py gooddata_api_client/model/compound_measure_value_filter.py gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py +gooddata_api_client/model/computation_profile.py +gooddata_api_client/model/computation_profile_source.py gooddata_api_client/model/computed_attribute_permissions.py gooddata_api_client/model/computed_attribute_permissions_assignment.py gooddata_api_client/model/computed_attribute_permissions_for_assignee.py @@ -2146,6 +2165,8 @@ gooddata_api_client/model/dataset_grain.py gooddata_api_client/model/dataset_reference_identifier.py gooddata_api_client/model/dataset_workspace_data_filter_identifier.py gooddata_api_client/model/date_filter.py +gooddata_api_client/model/date_range_parameter_definition.py +gooddata_api_client/model/date_range_parameter_value.py gooddata_api_client/model/date_value.py gooddata_api_client/model/declarative_agent.py gooddata_api_client/model/declarative_agents.py @@ -2198,6 +2219,7 @@ gooddata_api_client/model/declarative_label_translation.py gooddata_api_client/model/declarative_ldm.py gooddata_api_client/model/declarative_memory_item.py gooddata_api_client/model/declarative_metric.py +gooddata_api_client/model/declarative_metric_extension.py gooddata_api_client/model/declarative_metric_permission_assignment.py gooddata_api_client/model/declarative_metric_permission_for_assignee.py gooddata_api_client/model/declarative_metric_permission_for_assignee_rule.py @@ -2239,6 +2261,7 @@ gooddata_api_client/model/declarative_user_permissions.py gooddata_api_client/model/declarative_users.py gooddata_api_client/model/declarative_users_user_groups.py gooddata_api_client/model/declarative_visualization_object.py +gooddata_api_client/model/declarative_visualization_object_extension.py gooddata_api_client/model/declarative_visualization_object_permission_assignment.py gooddata_api_client/model/declarative_visualization_object_permission_for_assignee.py gooddata_api_client/model/declarative_visualization_object_permission_for_assignee_rule.py @@ -2342,6 +2365,7 @@ gooddata_api_client/model/get_ai_lake_operation200_response.py gooddata_api_client/model/get_document_export202_response_inner.py gooddata_api_client/model/get_quality_issues_response.py gooddata_api_client/model/get_service_status_response.py +gooddata_api_client/model/good_data_ai_provider_config.py gooddata_api_client/model/grain_identifier.py gooddata_api_client/model/granted_permission.py gooddata_api_client/model/granularities_formatting.py @@ -3199,6 +3223,10 @@ gooddata_api_client/model/localization_count.py gooddata_api_client/model/localization_data_statistics.py gooddata_api_client/model/localization_default.py gooddata_api_client/model/localization_defaults.py +gooddata_api_client/model/localization_issue.py +gooddata_api_client/model/localization_issue_workspace.py +gooddata_api_client/model/localization_issue_workspaces.py +gooddata_api_client/model/localization_issues.py gooddata_api_client/model/localization_metadata_statistics.py gooddata_api_client/model/localization_resolved_value.py gooddata_api_client/model/localization_resolved_values.py @@ -3207,6 +3235,8 @@ gooddata_api_client/model/localization_setting_usages.py gooddata_api_client/model/localization_source_counts.py gooddata_api_client/model/localization_statistics.py gooddata_api_client/model/localization_statistics_locale.py +gooddata_api_client/model/localization_statistics_translated_locale.py +gooddata_api_client/model/localization_statistics_workspace.py gooddata_api_client/model/localization_usage.py gooddata_api_client/model/localization_usage_user.py gooddata_api_client/model/localization_usage_users.py @@ -3286,6 +3316,8 @@ gooddata_api_client/model/parameter.py gooddata_api_client/model/parameter_definition.py gooddata_api_client/model/parameter_item.py gooddata_api_client/model/parameter_value.py +gooddata_api_client/model/parameterized_date_filter.py +gooddata_api_client/model/parameterized_date_filter_parameterized_date_filter.py gooddata_api_client/model/pdf_table_style.py gooddata_api_client/model/pdf_table_style_property.py gooddata_api_client/model/pdm_ldm_request.py @@ -3509,6 +3541,8 @@ gooddata_api_client/model/user_management_users_item.py gooddata_api_client/model/user_management_workspace_permission_assignment.py gooddata_api_client/model/user_permission.py gooddata_api_client/model/validate_by_item.py +gooddata_api_client/model/validate_embedding_origin_request.py +gooddata_api_client/model/validate_embedding_origin_response.py gooddata_api_client/model/validity_period_cache_retention.py gooddata_api_client/model/value.py gooddata_api_client/model/visible_filter.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 3a91db7d0..6af4596aa 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -108,6 +108,7 @@ Class | Method | HTTP request | Description *AILakeApi* | [**list_ai_lake_object_storages**](docs/AILakeApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages *AILakeApi* | [**list_ai_lake_services**](docs/AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services *AILakeApi* | [**provision_ai_lake_database_instance**](docs/AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance +*AILakeApi* | [**refresh_ai_lake_data_source**](docs/AILakeApi.md#refresh_ai_lake_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh | (BETA) Refresh an AI Lake data source *AILakeApi* | [**remove_ai_lake_database_data_source**](docs/AILakeApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance *AILakeApi* | [**run_ai_lake_service_command**](docs/AILakeApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command *AILakeApi* | [**update_ai_lake_database_data_source**](docs/AILakeApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance @@ -119,6 +120,7 @@ Class | Method | HTTP request | Description *AILakeDatabasesApi* | [**list_ai_lake_database_instances**](docs/AILakeDatabasesApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances *AILakeDatabasesApi* | [**list_ai_lake_object_storages**](docs/AILakeDatabasesApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages *AILakeDatabasesApi* | [**provision_ai_lake_database_instance**](docs/AILakeDatabasesApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance +*AILakeDatabasesApi* | [**refresh_ai_lake_data_source**](docs/AILakeDatabasesApi.md#refresh_ai_lake_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh | (BETA) Refresh an AI Lake data source *AILakeDatabasesApi* | [**remove_ai_lake_database_data_source**](docs/AILakeDatabasesApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance *AILakeDatabasesApi* | [**update_ai_lake_database_data_source**](docs/AILakeDatabasesApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance *AILakeServicesOperationsApi* | [**get_ai_lake_operation**](docs/AILakeServicesOperationsApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details @@ -166,12 +168,12 @@ Class | Method | HTTP request | Description *AttributeHierarchiesApi* | [**get_all_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies *AttributeHierarchiesApi* | [**get_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy *AttributeHierarchiesApi* | [**patch_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -*AttributeHierarchiesApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +*AttributeHierarchiesApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint *AttributeHierarchiesApi* | [**update_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy *AttributesApi* | [**get_all_entities_attributes**](docs/AttributesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes *AttributesApi* | [**get_entity_attributes**](docs/AttributesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -*AttributesApi* | [**patch_entity_attributes**](docs/AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -*AttributesApi* | [**search_entities_attributes**](docs/AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) +*AttributesApi* | [**patch_entity_attributes**](docs/AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute +*AttributesApi* | [**search_entities_attributes**](docs/AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint *AutomationsApi* | [**create_entity_automations**](docs/AutomationsApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations *AutomationsApi* | [**delete_entity_automations**](docs/AutomationsApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation *AutomationsApi* | [**delete_organization_automations**](docs/AutomationsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces @@ -183,8 +185,8 @@ Class | Method | HTTP request | Description *AutomationsApi* | [**patch_entity_automations**](docs/AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation *AutomationsApi* | [**pause_organization_automations**](docs/AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces *AutomationsApi* | [**pause_workspace_automations**](docs/AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace -*AutomationsApi* | [**search_entities_automation_results**](docs/AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) -*AutomationsApi* | [**search_entities_automations**](docs/AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +*AutomationsApi* | [**search_entities_automation_results**](docs/AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint +*AutomationsApi* | [**search_entities_automations**](docs/AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint *AutomationsApi* | [**set_automations**](docs/AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations *AutomationsApi* | [**trigger_automation**](docs/AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. *AutomationsApi* | [**trigger_existing_automation**](docs/AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -222,12 +224,13 @@ Class | Method | HTTP request | Description *ComputationApi* | [**retrieve_execution_metadata**](docs/ComputationApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata. *ComputationApi* | [**retrieve_result**](docs/ComputationApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result *ComputationApi* | [**retrieve_result_binary**](docs/ComputationApi.md#retrieve_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary | (BETA) Get a single execution result in Apache Arrow File or Stream format +*ComputationApi* | [**stream_execution_progress**](docs/ComputationApi.md#stream_execution_progress) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId} | (EXPERIMENTAL) Stream the live progress of an AFM execution *ComputedAttributesApi* | [**create_entity_computed_attributes**](docs/ComputedAttributesApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes *ComputedAttributesApi* | [**delete_entity_computed_attributes**](docs/ComputedAttributesApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute *ComputedAttributesApi* | [**get_all_entities_computed_attributes**](docs/ComputedAttributesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes *ComputedAttributesApi* | [**get_entity_computed_attributes**](docs/ComputedAttributesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute *ComputedAttributesApi* | [**patch_entity_computed_attributes**](docs/ComputedAttributesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute -*ComputedAttributesApi* | [**search_entities_computed_attributes**](docs/ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +*ComputedAttributesApi* | [**search_entities_computed_attributes**](docs/ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint *ComputedAttributesApi* | [**update_entity_computed_attributes**](docs/ComputedAttributesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute *CookieSecurityConfigurationApi* | [**get_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *CookieSecurityConfigurationApi* | [**patch_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration @@ -237,7 +240,7 @@ Class | Method | HTTP request | Description *DashboardsApi* | [**get_all_entities_analytical_dashboards**](docs/DashboardsApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards *DashboardsApi* | [**get_entity_analytical_dashboards**](docs/DashboardsApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard *DashboardsApi* | [**patch_entity_analytical_dashboards**](docs/DashboardsApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -*DashboardsApi* | [**search_entities_analytical_dashboards**](docs/DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +*DashboardsApi* | [**search_entities_analytical_dashboards**](docs/DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint *DashboardsApi* | [**update_entity_analytical_dashboards**](docs/DashboardsApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards *DataFiltersApi* | [**create_entity_user_data_filters**](docs/DataFiltersApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters *DataFiltersApi* | [**create_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters @@ -255,9 +258,9 @@ Class | Method | HTTP request | Description *DataFiltersApi* | [**patch_entity_user_data_filters**](docs/DataFiltersApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter *DataFiltersApi* | [**patch_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter *DataFiltersApi* | [**patch_entity_workspace_data_filters**](docs/DataFiltersApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -*DataFiltersApi* | [**search_entities_user_data_filters**](docs/DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) -*DataFiltersApi* | [**search_entities_workspace_data_filter_settings**](docs/DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) -*DataFiltersApi* | [**search_entities_workspace_data_filters**](docs/DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +*DataFiltersApi* | [**search_entities_user_data_filters**](docs/DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint +*DataFiltersApi* | [**search_entities_workspace_data_filter_settings**](docs/DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint +*DataFiltersApi* | [**search_entities_workspace_data_filters**](docs/DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint *DataFiltersApi* | [**set_workspace_data_filters_layout**](docs/DataFiltersApi.md#set_workspace_data_filters_layout) | **PUT** /api/v1/layout/workspaceDataFilters | Set all workspace data filters *DataFiltersApi* | [**update_entity_user_data_filters**](docs/DataFiltersApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter *DataFiltersApi* | [**update_entity_workspace_data_filter_settings**](docs/DataFiltersApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter @@ -286,8 +289,8 @@ Class | Method | HTTP request | Description *DataSourceStagingLocationApi* | [**staging_upload**](docs/DataSourceStagingLocationApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area *DatasetsApi* | [**get_all_entities_datasets**](docs/DatasetsApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets *DatasetsApi* | [**get_entity_datasets**](docs/DatasetsApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -*DatasetsApi* | [**patch_entity_datasets**](docs/DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -*DatasetsApi* | [**search_entities_datasets**](docs/DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +*DatasetsApi* | [**patch_entity_datasets**](docs/DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset +*DatasetsApi* | [**search_entities_datasets**](docs/DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint *DependencyGraphApi* | [**get_dependent_entities_graph**](docs/DependencyGraphApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph *DependencyGraphApi* | [**get_dependent_entities_graph_from_entry_points**](docs/DependencyGraphApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points *EntitlementApi* | [**get_all_entities_entitlements**](docs/EntitlementApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements @@ -299,7 +302,7 @@ Class | Method | HTTP request | Description *ExportDefinitionsApi* | [**get_all_entities_export_definitions**](docs/ExportDefinitionsApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions *ExportDefinitionsApi* | [**get_entity_export_definitions**](docs/ExportDefinitionsApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition *ExportDefinitionsApi* | [**patch_entity_export_definitions**](docs/ExportDefinitionsApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -*ExportDefinitionsApi* | [**search_entities_export_definitions**](docs/ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +*ExportDefinitionsApi* | [**search_entities_export_definitions**](docs/ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint *ExportDefinitionsApi* | [**update_entity_export_definitions**](docs/ExportDefinitionsApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition *ExportTemplatesApi* | [**create_entity_export_templates**](docs/ExportTemplatesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *ExportTemplatesApi* | [**create_entity_workspace_export_templates**](docs/ExportTemplatesApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template @@ -317,15 +320,15 @@ Class | Method | HTTP request | Description *FactsApi* | [**get_all_entities_facts**](docs/FactsApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts *FactsApi* | [**get_entity_aggregated_facts**](docs/FactsApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | Get an Aggregated Fact *FactsApi* | [**get_entity_facts**](docs/FactsApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -*FactsApi* | [**patch_entity_facts**](docs/FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -*FactsApi* | [**search_entities_aggregated_facts**](docs/FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) -*FactsApi* | [**search_entities_facts**](docs/FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +*FactsApi* | [**patch_entity_facts**](docs/FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact +*FactsApi* | [**search_entities_aggregated_facts**](docs/FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint +*FactsApi* | [**search_entities_facts**](docs/FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint *FilterContextApi* | [**create_entity_filter_contexts**](docs/FilterContextApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context *FilterContextApi* | [**delete_entity_filter_contexts**](docs/FilterContextApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context *FilterContextApi* | [**get_all_entities_filter_contexts**](docs/FilterContextApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context *FilterContextApi* | [**get_entity_filter_contexts**](docs/FilterContextApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context *FilterContextApi* | [**patch_entity_filter_contexts**](docs/FilterContextApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -*FilterContextApi* | [**search_entities_filter_contexts**](docs/FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +*FilterContextApi* | [**search_entities_filter_contexts**](docs/FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint *FilterContextApi* | [**update_entity_filter_contexts**](docs/FilterContextApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context *FilterViewsApi* | [**create_entity_filter_views**](docs/FilterViewsApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views *FilterViewsApi* | [**delete_entity_filter_views**](docs/FilterViewsApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view @@ -333,7 +336,7 @@ Class | Method | HTTP request | Description *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* | [**search_entities_filter_views**](docs/FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +*FilterViewsApi* | [**search_entities_filter_views**](docs/FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint *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 *FiscalCalendarsApi* | [**get_all_entities_fiscal_calendars**](docs/FiscalCalendarsApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars @@ -380,7 +383,7 @@ Class | Method | HTTP request | Description *KnowledgeRecommendationsApi* | [**get_all_entities_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations *KnowledgeRecommendationsApi* | [**get_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation *KnowledgeRecommendationsApi* | [**patch_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -*KnowledgeRecommendationsApi* | [**search_entities_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +*KnowledgeRecommendationsApi* | [**search_entities_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint *KnowledgeRecommendationsApi* | [**update_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation *LDMDeclarativeAPIsApi* | [**get_logical_model**](docs/LDMDeclarativeAPIsApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model *LDMDeclarativeAPIsApi* | [**set_logical_model**](docs/LDMDeclarativeAPIsApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model @@ -398,15 +401,19 @@ Class | Method | HTTP request | Description *LLMProvidersApi* | [**update_entity_llm_providers**](docs/LLMProvidersApi.md#update_entity_llm_providers) | **PUT** /api/v1/entities/llmProviders/{id} | PUT LLM Provider entity *LabelsApi* | [**get_all_entities_labels**](docs/LabelsApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *LabelsApi* | [**get_entity_labels**](docs/LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label -*LabelsApi* | [**patch_entity_labels**](docs/LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -*LabelsApi* | [**search_entities_labels**](docs/LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) -*LocalizationApi* | [**organization_localization_statistics**](docs/LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. -*LocalizationApi* | [**organization_localization_usage**](docs/LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. -*LocalizationApi* | [**organization_localization_usage_users**](docs/LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. -*LocalizationApi* | [**organization_localization_usage_workspaces**](docs/LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. -*LocalizationApi* | [**workspace_localization_statistics**](docs/LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. -*LocalizationApi* | [**workspace_localization_usage**](docs/LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. -*LocalizationApi* | [**workspace_localization_usage_users**](docs/LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. +*LabelsApi* | [**patch_entity_labels**](docs/LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label +*LabelsApi* | [**search_entities_labels**](docs/LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint +*LocalizationApi* | [**organization_localization_issue_workspaces**](docs/LocalizationApi.md#organization_localization_issue_workspaces) | **GET** /api/v1/actions/organization/localization/issues/workspaces | (BETA) Workspaces with a localization issue. +*LocalizationApi* | [**organization_localization_issues**](docs/LocalizationApi.md#organization_localization_issues) | **GET** /api/v1/actions/organization/localization/issues | (BETA) Localization issues of the organization. +*LocalizationApi* | [**organization_localization_statistics**](docs/LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | Languages with translations in the organization. +*LocalizationApi* | [**organization_localization_usage**](docs/LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | Languages used in the organization. +*LocalizationApi* | [**organization_localization_usage_users**](docs/LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | Users who set a language themselves. +*LocalizationApi* | [**organization_localization_usage_workspaces**](docs/LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | Workspaces that use a language. +*LocalizationApi* | [**workspace_localization_issues**](docs/LocalizationApi.md#workspace_localization_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/issues | (BETA) Localization issues of the workspace. +*LocalizationApi* | [**workspace_localization_statistics**](docs/LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | Languages with translations in the workspace. +*LocalizationApi* | [**workspace_localization_usage**](docs/LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | Languages used in the workspace. +*LocalizationApi* | [**workspace_localization_usage_child_workspaces**](docs/LocalizationApi.md#workspace_localization_usage_child_workspaces) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces | (BETA) Workspaces below the workspace that use a language. +*LocalizationApi* | [**workspace_localization_usage_users**](docs/LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | Workspace members who get a language. *ManagePermissionsApi* | [**get_data_source_permissions**](docs/ManagePermissionsApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source *ManagePermissionsApi* | [**manage_data_source_permissions**](docs/ManagePermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *ManagePermissionsApi* | [**set_data_source_permissions**](docs/ManagePermissionsApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. @@ -420,7 +427,7 @@ Class | Method | HTTP request | Description *MemoryItemsApi* | [**get_entity_org_memory_items**](docs/MemoryItemsApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity *MemoryItemsApi* | [**patch_entity_memory_items**](docs/MemoryItemsApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item *MemoryItemsApi* | [**patch_entity_org_memory_items**](docs/MemoryItemsApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity -*MemoryItemsApi* | [**search_entities_memory_items**](docs/MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +*MemoryItemsApi* | [**search_entities_memory_items**](docs/MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint *MemoryItemsApi* | [**update_entity_memory_items**](docs/MemoryItemsApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item *MemoryItemsApi* | [**update_entity_org_memory_items**](docs/MemoryItemsApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity *MetadataSynchronizationApi* | [**sync_metadata**](docs/MetadataSynchronizationApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization @@ -429,7 +436,7 @@ Class | Method | HTTP request | Description *MetricsApi* | [**get_all_entities_metrics**](docs/MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics *MetricsApi* | [**get_entity_metrics**](docs/MetricsApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric *MetricsApi* | [**patch_entity_metrics**](docs/MetricsApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -*MetricsApi* | [**search_entities_metrics**](docs/MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +*MetricsApi* | [**search_entities_metrics**](docs/MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint *MetricsApi* | [**update_entity_metrics**](docs/MetricsApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric *NotificationChannelsApi* | [**create_entity_notification_channels**](docs/NotificationChannelsApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities *NotificationChannelsApi* | [**delete_entity_notification_channels**](docs/NotificationChannelsApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -480,11 +487,11 @@ Class | Method | HTTP request | Description *ParametersApi* | [**get_all_entities_parameters**](docs/ParametersApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters *ParametersApi* | [**get_entity_parameters**](docs/ParametersApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter *ParametersApi* | [**patch_entity_parameters**](docs/ParametersApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter -*ParametersApi* | [**search_entities_parameters**](docs/ParametersApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) +*ParametersApi* | [**search_entities_parameters**](docs/ParametersApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint *ParametersApi* | [**update_entity_parameters**](docs/ParametersApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter *PermissionsApi* | [**attribute_permissions**](docs/PermissionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions *PermissionsApi* | [**available_assignees**](docs/PermissionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees -*PermissionsApi* | [**computed_attribute_permissions**](docs/PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions +*PermissionsApi* | [**computed_attribute_permissions**](docs/PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | Get Computed Attribute Permissions *PermissionsApi* | [**dashboard_permissions**](docs/PermissionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions *PermissionsApi* | [**fact_permissions**](docs/PermissionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions *PermissionsApi* | [**get_organization_permissions**](docs/PermissionsApi.md#get_organization_permissions) | **GET** /api/v1/layout/organization/permissions | Get organization permissions @@ -493,27 +500,27 @@ Class | Method | HTTP request | Description *PermissionsApi* | [**get_workspace_permissions**](docs/PermissionsApi.md#get_workspace_permissions) | **GET** /api/v1/layout/workspaces/{workspaceId}/permissions | Get permissions for the workspace *PermissionsApi* | [**label_permissions**](docs/PermissionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions *PermissionsApi* | [**manage_attribute_permissions**](docs/PermissionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute -*PermissionsApi* | [**manage_computed_attribute_permissions**](docs/PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute +*PermissionsApi* | [**manage_computed_attribute_permissions**](docs/PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | Manage Permissions for a Computed Attribute *PermissionsApi* | [**manage_dashboard_permissions**](docs/PermissionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard *PermissionsApi* | [**manage_data_source_permissions**](docs/PermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *PermissionsApi* | [**manage_fact_permissions**](docs/PermissionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact *PermissionsApi* | [**manage_label_permissions**](docs/PermissionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label -*PermissionsApi* | [**manage_metric_permissions**](docs/PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric +*PermissionsApi* | [**manage_metric_permissions**](docs/PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | Manage Permissions for a Metric *PermissionsApi* | [**manage_organization_permissions**](docs/PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization -*PermissionsApi* | [**manage_visualization_permissions**](docs/PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization +*PermissionsApi* | [**manage_visualization_permissions**](docs/PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | Manage Permissions for a Visualization *PermissionsApi* | [**manage_workspace_permissions**](docs/PermissionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace -*PermissionsApi* | [**metric_permissions**](docs/PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions +*PermissionsApi* | [**metric_permissions**](docs/PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | Get Metric Permissions *PermissionsApi* | [**set_organization_permissions**](docs/PermissionsApi.md#set_organization_permissions) | **PUT** /api/v1/layout/organization/permissions | Set organization permissions *PermissionsApi* | [**set_user_group_permissions**](docs/PermissionsApi.md#set_user_group_permissions) | **PUT** /api/v1/layout/userGroups/{userGroupId}/permissions | Set permissions for the user-group *PermissionsApi* | [**set_user_permissions**](docs/PermissionsApi.md#set_user_permissions) | **PUT** /api/v1/layout/users/{userId}/permissions | Set permissions for the user *PermissionsApi* | [**set_workspace_permissions**](docs/PermissionsApi.md#set_workspace_permissions) | **PUT** /api/v1/layout/workspaces/{workspaceId}/permissions | Set permissions for the workspace -*PermissionsApi* | [**visualization_permissions**](docs/PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions +*PermissionsApi* | [**visualization_permissions**](docs/PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | Get Visualization Permissions *PluginsApi* | [**create_entity_dashboard_plugins**](docs/PluginsApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins *PluginsApi* | [**delete_entity_dashboard_plugins**](docs/PluginsApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin *PluginsApi* | [**get_all_entities_dashboard_plugins**](docs/PluginsApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins *PluginsApi* | [**get_entity_dashboard_plugins**](docs/PluginsApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin *PluginsApi* | [**patch_entity_dashboard_plugins**](docs/PluginsApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -*PluginsApi* | [**search_entities_dashboard_plugins**](docs/PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +*PluginsApi* | [**search_entities_dashboard_plugins**](docs/PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint *PluginsApi* | [**update_entity_dashboard_plugins**](docs/PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *PublisherDocumentsApi* | [**create_entity_document_templates**](docs/PublisherDocumentsApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template *PublisherDocumentsApi* | [**create_entity_documents**](docs/PublisherDocumentsApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document @@ -530,11 +537,12 @@ Class | Method | HTTP request | Description *PublisherDocumentsApi* | [**patch_entity_document_templates**](docs/PublisherDocumentsApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template *PublisherDocumentsApi* | [**patch_entity_documents**](docs/PublisherDocumentsApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document *PublisherDocumentsApi* | [**patch_entity_page_templates**](docs/PublisherDocumentsApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +*PublisherDocumentsApi* | [**search_entities_documents**](docs/PublisherDocumentsApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint *PublisherDocumentsApi* | [**update_entity_document_templates**](docs/PublisherDocumentsApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template *PublisherDocumentsApi* | [**update_entity_documents**](docs/PublisherDocumentsApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document *PublisherDocumentsApi* | [**update_entity_page_templates**](docs/PublisherDocumentsApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template -*RawExportApi* | [**create_raw_export**](docs/RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request -*RawExportApi* | [**get_raw_export**](docs/RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +*RawExportApi* | [**create_raw_export**](docs/RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | Create raw export request +*RawExportApi* | [**get_raw_export**](docs/RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | Retrieve exported files *ReportExportApi* | [**create_document_export**](docs/ReportExportApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request *ReportExportApi* | [**create_report_export**](docs/ReportExportApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request *ReportExportApi* | [**get_document_export**](docs/ReportExportApi.md#get_document_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId} | (EXPERIMENTAL) Retrieve exported document @@ -543,6 +551,7 @@ Class | Method | HTTP request | Description *ReportExportApi* | [**get_report_export_metadata**](docs/ReportExportApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *ReportingSettingsApi* | [**resolve_all_settings_without_workspace**](docs/ReportingSettingsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. *ReportingSettingsApi* | [**resolve_settings_without_workspace**](docs/ReportingSettingsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace. +*ReportingSettingsApi* | [**validate_embedding_origin**](docs/ReportingSettingsApi.md#validate_embedding_origin) | **POST** /api/v1/actions/validateEmbeddingOrigin | Validate an embedding origin. *ReportsApi* | [**create_entity_report_page_layouts**](docs/ReportsApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout *ReportsApi* | [**create_entity_report_templates**](docs/ReportsApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template *ReportsApi* | [**create_entity_reports**](docs/ReportsApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report @@ -660,7 +669,7 @@ Class | Method | HTTP request | Description *VisualizationObjectApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects *VisualizationObjectApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object *VisualizationObjectApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -*VisualizationObjectApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +*VisualizationObjectApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint *VisualizationObjectApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object *WorkspacesDeclarativeAPIsApi* | [**get_workspace_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspace_layout) | **GET** /api/v1/layout/workspaces/{workspaceId} | Get workspace layout *WorkspacesDeclarativeAPIsApi* | [**get_workspaces_layout**](docs/WorkspacesDeclarativeAPIsApi.md#get_workspaces_layout) | **GET** /api/v1/layout/workspaces | Get all workspaces layout @@ -682,8 +691,8 @@ Class | Method | HTTP request | Description *WorkspacesSettingsApi* | [**get_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace *WorkspacesSettingsApi* | [**patch_entity_custom_application_settings**](docs/WorkspacesSettingsApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting *WorkspacesSettingsApi* | [**patch_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -*WorkspacesSettingsApi* | [**search_entities_custom_application_settings**](docs/WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) -*WorkspacesSettingsApi* | [**search_entities_workspace_settings**](docs/WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +*WorkspacesSettingsApi* | [**search_entities_custom_application_settings**](docs/WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint +*WorkspacesSettingsApi* | [**search_entities_workspace_settings**](docs/WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint *WorkspacesSettingsApi* | [**update_entity_custom_application_settings**](docs/WorkspacesSettingsApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting *WorkspacesSettingsApi* | [**update_entity_workspace_settings**](docs/WorkspacesSettingsApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace *WorkspacesSettingsApi* | [**workspace_resolve_all_settings**](docs/WorkspacesSettingsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -715,13 +724,13 @@ Class | Method | HTTP request | Description *ActionsApi* | [**compute_report_for_visualization_object**](docs/ActionsApi.md#compute_report_for_visualization_object) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute | (BETA) Executes a visualization object and returns link to the result *ActionsApi* | [**compute_valid_descendants**](docs/ActionsApi.md#compute_valid_descendants) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants | (BETA) Valid descendants *ActionsApi* | [**compute_valid_objects**](docs/ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects -*ActionsApi* | [**computed_attribute_permissions**](docs/ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions +*ActionsApi* | [**computed_attribute_permissions**](docs/ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | Get Computed Attribute Permissions *ActionsApi* | [**convert_geo_file**](docs/ActionsApi.md#convert_geo_file) | **POST** /api/v1/actions/customGeoCollection/convert | Convert a geo file to GeoParquet format *ActionsApi* | [**create_dashboard_export_request**](docs/ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request *ActionsApi* | [**create_document_export**](docs/ActionsApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request *ActionsApi* | [**create_image_export**](docs/ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request *ActionsApi* | [**create_pdf_export**](docs/ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request -*ActionsApi* | [**create_raw_export**](docs/ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request +*ActionsApi* | [**create_raw_export**](docs/ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | Create raw export request *ActionsApi* | [**create_report_export**](docs/ActionsApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request *ActionsApi* | [**create_slides_export**](docs/ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request *ActionsApi* | [**create_tabular_export**](docs/ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request @@ -751,7 +760,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**get_notifications**](docs/ActionsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications. *ActionsApi* | [**get_quality_issues**](docs/ActionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues *ActionsApi* | [**get_quality_issues_calculation_status**](docs/ActionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status -*ActionsApi* | [**get_raw_export**](docs/ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +*ActionsApi* | [**get_raw_export**](docs/ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | Retrieve exported files *ActionsApi* | [**get_report_export**](docs/ActionsApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files *ActionsApi* | [**get_report_export_metadata**](docs/ActionsApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *ActionsApi* | [**get_slides_export**](docs/ActionsApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files @@ -773,23 +782,25 @@ Class | Method | HTTP request | Description *ActionsApi* | [**list_workspace_user_groups**](docs/ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | *ActionsApi* | [**list_workspace_users**](docs/ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | *ActionsApi* | [**manage_attribute_permissions**](docs/ActionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute -*ActionsApi* | [**manage_computed_attribute_permissions**](docs/ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute +*ActionsApi* | [**manage_computed_attribute_permissions**](docs/ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | Manage Permissions for a Computed Attribute *ActionsApi* | [**manage_dashboard_permissions**](docs/ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard *ActionsApi* | [**manage_data_source_permissions**](docs/ActionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *ActionsApi* | [**manage_fact_permissions**](docs/ActionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact *ActionsApi* | [**manage_label_permissions**](docs/ActionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label -*ActionsApi* | [**manage_metric_permissions**](docs/ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric +*ActionsApi* | [**manage_metric_permissions**](docs/ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | Manage Permissions for a Metric *ActionsApi* | [**manage_organization_permissions**](docs/ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization -*ActionsApi* | [**manage_visualization_permissions**](docs/ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization +*ActionsApi* | [**manage_visualization_permissions**](docs/ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | Manage Permissions for a Visualization *ActionsApi* | [**manage_workspace_permissions**](docs/ActionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace *ActionsApi* | [**mark_as_read_notification**](docs/ActionsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. *ActionsApi* | [**mark_as_read_notification_all**](docs/ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. *ActionsApi* | [**memory_created_by_users**](docs/ActionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users -*ActionsApi* | [**metric_permissions**](docs/ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions -*ActionsApi* | [**organization_localization_statistics**](docs/ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. -*ActionsApi* | [**organization_localization_usage**](docs/ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. -*ActionsApi* | [**organization_localization_usage_users**](docs/ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. -*ActionsApi* | [**organization_localization_usage_workspaces**](docs/ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. +*ActionsApi* | [**metric_permissions**](docs/ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | Get Metric Permissions +*ActionsApi* | [**organization_localization_issue_workspaces**](docs/ActionsApi.md#organization_localization_issue_workspaces) | **GET** /api/v1/actions/organization/localization/issues/workspaces | (BETA) Workspaces with a localization issue. +*ActionsApi* | [**organization_localization_issues**](docs/ActionsApi.md#organization_localization_issues) | **GET** /api/v1/actions/organization/localization/issues | (BETA) Localization issues of the organization. +*ActionsApi* | [**organization_localization_statistics**](docs/ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | Languages with translations in the organization. +*ActionsApi* | [**organization_localization_usage**](docs/ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | Languages used in the organization. +*ActionsApi* | [**organization_localization_usage_users**](docs/ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | Users who set a language themselves. +*ActionsApi* | [**organization_localization_usage_workspaces**](docs/ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | Workspaces that use a language. *ActionsApi* | [**outlier_detection**](docs/ActionsApi.md#outlier_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers | (BETA) Outlier Detection *ActionsApi* | [**outlier_detection_result**](docs/ActionsApi.md#outlier_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId} | (BETA) Outlier Detection Result *ActionsApi* | [**overridden_child_entities**](docs/ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. @@ -820,6 +831,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**set_certification**](docs/ActionsApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification *ActionsApi* | [**set_translations**](docs/ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities. *ActionsApi* | [**staging_upload**](docs/ActionsApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area +*ActionsApi* | [**stream_execution_progress**](docs/ActionsApi.md#stream_execution_progress) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId} | (EXPERIMENTAL) Stream the live progress of an AFM execution *ActionsApi* | [**switch_active_identity_provider**](docs/ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider *ActionsApi* | [**sync_metadata**](docs/ActionsApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization *ActionsApi* | [**tags**](docs/ActionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags @@ -840,12 +852,15 @@ Class | Method | HTTP request | Description *ActionsApi* | [**unsubscribe_organization_automations**](docs/ActionsApi.md#unsubscribe_organization_automations) | **POST** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from selected automations across all workspaces *ActionsApi* | [**unsubscribe_selected_workspace_automations**](docs/ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace *ActionsApi* | [**unsubscribe_workspace_automations**](docs/ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace +*ActionsApi* | [**validate_embedding_origin**](docs/ActionsApi.md#validate_embedding_origin) | **POST** /api/v1/actions/validateEmbeddingOrigin | Validate an embedding origin. *ActionsApi* | [**validate_llm_endpoint**](docs/ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint (Removed) *ActionsApi* | [**validate_llm_endpoint_by_id**](docs/ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id (Removed) -*ActionsApi* | [**visualization_permissions**](docs/ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions -*ActionsApi* | [**workspace_localization_statistics**](docs/ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. -*ActionsApi* | [**workspace_localization_usage**](docs/ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. -*ActionsApi* | [**workspace_localization_usage_users**](docs/ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. +*ActionsApi* | [**visualization_permissions**](docs/ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | Get Visualization Permissions +*ActionsApi* | [**workspace_localization_issues**](docs/ActionsApi.md#workspace_localization_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/issues | (BETA) Localization issues of the workspace. +*ActionsApi* | [**workspace_localization_statistics**](docs/ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | Languages with translations in the workspace. +*ActionsApi* | [**workspace_localization_usage**](docs/ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | Languages used in the workspace. +*ActionsApi* | [**workspace_localization_usage_child_workspaces**](docs/ActionsApi.md#workspace_localization_usage_child_workspaces) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces | (BETA) Workspaces below the workspace that use a language. +*ActionsApi* | [**workspace_localization_usage_users**](docs/ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | Workspace members who get a language. *ActionsApi* | [**workspace_resolve_all_settings**](docs/ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. *ActionsApi* | [**workspace_resolve_settings**](docs/ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. *AgentControllerApi* | [**create_entity_agents**](docs/AgentControllerApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities @@ -856,13 +871,13 @@ Class | Method | HTTP request | Description *AgentControllerApi* | [**update_entity_agents**](docs/AgentControllerApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity *AggregatedFactControllerApi* | [**get_all_entities_aggregated_facts**](docs/AggregatedFactControllerApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | Get all Aggregated Facts *AggregatedFactControllerApi* | [**get_entity_aggregated_facts**](docs/AggregatedFactControllerApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | Get an Aggregated Fact -*AggregatedFactControllerApi* | [**search_entities_aggregated_facts**](docs/AggregatedFactControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) +*AggregatedFactControllerApi* | [**search_entities_aggregated_facts**](docs/AggregatedFactControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint *AnalyticalDashboardControllerApi* | [**create_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards *AnalyticalDashboardControllerApi* | [**delete_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#delete_entity_analytical_dashboards) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Delete a Dashboard *AnalyticalDashboardControllerApi* | [**get_all_entities_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards *AnalyticalDashboardControllerApi* | [**get_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard *AnalyticalDashboardControllerApi* | [**patch_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -*AnalyticalDashboardControllerApi* | [**search_entities_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +*AnalyticalDashboardControllerApi* | [**search_entities_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint *AnalyticalDashboardControllerApi* | [**update_entity_analytical_dashboards**](docs/AnalyticalDashboardControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards *ApiTokenControllerApi* | [**create_entity_api_tokens**](docs/ApiTokenControllerApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user *ApiTokenControllerApi* | [**delete_entity_api_tokens**](docs/ApiTokenControllerApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user @@ -870,14 +885,14 @@ Class | Method | HTTP request | Description *ApiTokenControllerApi* | [**get_entity_api_tokens**](docs/ApiTokenControllerApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user *AttributeControllerApi* | [**get_all_entities_attributes**](docs/AttributeControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes *AttributeControllerApi* | [**get_entity_attributes**](docs/AttributeControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -*AttributeControllerApi* | [**patch_entity_attributes**](docs/AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -*AttributeControllerApi* | [**search_entities_attributes**](docs/AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) +*AttributeControllerApi* | [**patch_entity_attributes**](docs/AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute +*AttributeControllerApi* | [**search_entities_attributes**](docs/AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint *AttributeHierarchyControllerApi* | [**create_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies *AttributeHierarchyControllerApi* | [**delete_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy *AttributeHierarchyControllerApi* | [**get_all_entities_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies *AttributeHierarchyControllerApi* | [**get_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy *AttributeHierarchyControllerApi* | [**patch_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -*AttributeHierarchyControllerApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +*AttributeHierarchyControllerApi* | [**search_entities_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint *AttributeHierarchyControllerApi* | [**update_entity_attribute_hierarchies**](docs/AttributeHierarchyControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy *AuthenticationApi* | [**get_profile**](docs/AuthenticationApi.md#get_profile) | **GET** /api/v1/profile | Get Profile *AutomationControllerApi* | [**create_entity_automations**](docs/AutomationControllerApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations @@ -885,10 +900,10 @@ Class | Method | HTTP request | Description *AutomationControllerApi* | [**get_all_entities_automations**](docs/AutomationControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations *AutomationControllerApi* | [**get_entity_automations**](docs/AutomationControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation *AutomationControllerApi* | [**patch_entity_automations**](docs/AutomationControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation -*AutomationControllerApi* | [**search_entities_automations**](docs/AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +*AutomationControllerApi* | [**search_entities_automations**](docs/AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint *AutomationControllerApi* | [**update_entity_automations**](docs/AutomationControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation *AutomationOrganizationViewControllerApi* | [**get_all_automations_workspace_automations**](docs/AutomationOrganizationViewControllerApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces -*AutomationResultControllerApi* | [**search_entities_automation_results**](docs/AutomationResultControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) +*AutomationResultControllerApi* | [**search_entities_automation_results**](docs/AutomationResultControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint *ColorPaletteControllerApi* | [**create_entity_color_palettes**](docs/ColorPaletteControllerApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes *ColorPaletteControllerApi* | [**delete_entity_color_palettes**](docs/ColorPaletteControllerApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette *ColorPaletteControllerApi* | [**get_all_entities_color_palettes**](docs/ColorPaletteControllerApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes @@ -900,7 +915,7 @@ Class | Method | HTTP request | Description *ComputedAttributeControllerApi* | [**get_all_entities_computed_attributes**](docs/ComputedAttributeControllerApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes *ComputedAttributeControllerApi* | [**get_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute *ComputedAttributeControllerApi* | [**patch_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute -*ComputedAttributeControllerApi* | [**search_entities_computed_attributes**](docs/ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +*ComputedAttributeControllerApi* | [**search_entities_computed_attributes**](docs/ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint *ComputedAttributeControllerApi* | [**update_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute *CookieSecurityConfigurationControllerApi* | [**get_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *CookieSecurityConfigurationControllerApi* | [**patch_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration @@ -916,7 +931,7 @@ Class | Method | HTTP request | Description *CustomApplicationSettingControllerApi* | [**get_all_entities_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings *CustomApplicationSettingControllerApi* | [**get_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting *CustomApplicationSettingControllerApi* | [**patch_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -*CustomApplicationSettingControllerApi* | [**search_entities_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +*CustomApplicationSettingControllerApi* | [**search_entities_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint *CustomApplicationSettingControllerApi* | [**update_entity_custom_application_settings**](docs/CustomApplicationSettingControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting *CustomGeoCollectionControllerApi* | [**create_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections *CustomGeoCollectionControllerApi* | [**delete_entity_custom_geo_collections**](docs/CustomGeoCollectionControllerApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection @@ -934,7 +949,7 @@ Class | Method | HTTP request | Description *DashboardPluginControllerApi* | [**get_all_entities_dashboard_plugins**](docs/DashboardPluginControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins *DashboardPluginControllerApi* | [**get_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin *DashboardPluginControllerApi* | [**patch_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -*DashboardPluginControllerApi* | [**search_entities_dashboard_plugins**](docs/DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +*DashboardPluginControllerApi* | [**search_entities_dashboard_plugins**](docs/DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint *DashboardPluginControllerApi* | [**update_entity_dashboard_plugins**](docs/DashboardPluginControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *DataSourceControllerApi* | [**create_entity_data_sources**](docs/DataSourceControllerApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources *DataSourceControllerApi* | [**delete_entity_data_sources**](docs/DataSourceControllerApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity @@ -946,13 +961,14 @@ Class | Method | HTTP request | Description *DataSourceIdentifierControllerApi* | [**get_entity_data_source_identifiers**](docs/DataSourceIdentifierControllerApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier *DatasetControllerApi* | [**get_all_entities_datasets**](docs/DatasetControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets *DatasetControllerApi* | [**get_entity_datasets**](docs/DatasetControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -*DatasetControllerApi* | [**patch_entity_datasets**](docs/DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -*DatasetControllerApi* | [**search_entities_datasets**](docs/DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +*DatasetControllerApi* | [**patch_entity_datasets**](docs/DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset +*DatasetControllerApi* | [**search_entities_datasets**](docs/DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint *DocumentControllerApi* | [**create_entity_documents**](docs/DocumentControllerApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document *DocumentControllerApi* | [**delete_entity_documents**](docs/DocumentControllerApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document *DocumentControllerApi* | [**get_all_entities_documents**](docs/DocumentControllerApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents *DocumentControllerApi* | [**get_entity_documents**](docs/DocumentControllerApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document *DocumentControllerApi* | [**patch_entity_documents**](docs/DocumentControllerApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +*DocumentControllerApi* | [**search_entities_documents**](docs/DocumentControllerApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint *DocumentControllerApi* | [**update_entity_documents**](docs/DocumentControllerApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document *DocumentTemplateControllerApi* | [**create_entity_document_templates**](docs/DocumentTemplateControllerApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template *DocumentTemplateControllerApi* | [**delete_entity_document_templates**](docs/DocumentTemplateControllerApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template @@ -1182,7 +1198,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_agents**](docs/EntitiesApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity *EntitiesApi* | [**patch_entity_analytical_dashboards**](docs/EntitiesApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard *EntitiesApi* | [**patch_entity_attribute_hierarchies**](docs/EntitiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -*EntitiesApi* | [**patch_entity_attributes**](docs/EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) +*EntitiesApi* | [**patch_entity_attributes**](docs/EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute *EntitiesApi* | [**patch_entity_automations**](docs/EntitiesApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation *EntitiesApi* | [**patch_entity_color_palettes**](docs/EntitiesApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette *EntitiesApi* | [**patch_entity_computed_attributes**](docs/EntitiesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute @@ -1192,18 +1208,18 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_custom_geo_collections**](docs/EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection *EntitiesApi* | [**patch_entity_dashboard_plugins**](docs/EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin *EntitiesApi* | [**patch_entity_data_sources**](docs/EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity -*EntitiesApi* | [**patch_entity_datasets**](docs/EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +*EntitiesApi* | [**patch_entity_datasets**](docs/EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset *EntitiesApi* | [**patch_entity_document_templates**](docs/EntitiesApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template *EntitiesApi* | [**patch_entity_documents**](docs/EntitiesApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document *EntitiesApi* | [**patch_entity_export_definitions**](docs/EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition *EntitiesApi* | [**patch_entity_export_templates**](docs/EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity -*EntitiesApi* | [**patch_entity_facts**](docs/EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) +*EntitiesApi* | [**patch_entity_facts**](docs/EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact *EntitiesApi* | [**patch_entity_filter_contexts**](docs/EntitiesApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context *EntitiesApi* | [**patch_entity_filter_views**](docs/EntitiesApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view *EntitiesApi* | [**patch_entity_identity_providers**](docs/EntitiesApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider *EntitiesApi* | [**patch_entity_jwks**](docs/EntitiesApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk *EntitiesApi* | [**patch_entity_knowledge_recommendations**](docs/EntitiesApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -*EntitiesApi* | [**patch_entity_labels**](docs/EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) +*EntitiesApi* | [**patch_entity_labels**](docs/EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label *EntitiesApi* | [**patch_entity_llm_providers**](docs/EntitiesApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity *EntitiesApi* | [**patch_entity_memory_items**](docs/EntitiesApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item *EntitiesApi* | [**patch_entity_metrics**](docs/EntitiesApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric @@ -1228,30 +1244,31 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_workspace_settings**](docs/EntitiesApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace *EntitiesApi* | [**patch_entity_workspace_themes**](docs/EntitiesApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme *EntitiesApi* | [**patch_entity_workspaces**](docs/EntitiesApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity -*EntitiesApi* | [**search_entities_aggregated_facts**](docs/EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_analytical_dashboards**](docs/EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_attribute_hierarchies**](docs/EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_attributes**](docs/EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_automation_results**](docs/EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_automations**](docs/EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_computed_attributes**](docs/EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_custom_application_settings**](docs/EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_dashboard_plugins**](docs/EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_datasets**](docs/EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_export_definitions**](docs/EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_facts**](docs/EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_filter_contexts**](docs/EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_filter_views**](docs/EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_knowledge_recommendations**](docs/EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_labels**](docs/EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_memory_items**](docs/EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_metrics**](docs/EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_parameters**](docs/EntitiesApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_user_data_filters**](docs/EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_visualization_objects**](docs/EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_workspace_data_filter_settings**](docs/EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_workspace_data_filters**](docs/EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) -*EntitiesApi* | [**search_entities_workspace_settings**](docs/EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_aggregated_facts**](docs/EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint +*EntitiesApi* | [**search_entities_analytical_dashboards**](docs/EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint +*EntitiesApi* | [**search_entities_attribute_hierarchies**](docs/EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint +*EntitiesApi* | [**search_entities_attributes**](docs/EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint +*EntitiesApi* | [**search_entities_automation_results**](docs/EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint +*EntitiesApi* | [**search_entities_automations**](docs/EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint +*EntitiesApi* | [**search_entities_computed_attributes**](docs/EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint +*EntitiesApi* | [**search_entities_custom_application_settings**](docs/EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint +*EntitiesApi* | [**search_entities_dashboard_plugins**](docs/EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint +*EntitiesApi* | [**search_entities_datasets**](docs/EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint +*EntitiesApi* | [**search_entities_documents**](docs/EntitiesApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint +*EntitiesApi* | [**search_entities_export_definitions**](docs/EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint +*EntitiesApi* | [**search_entities_facts**](docs/EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint +*EntitiesApi* | [**search_entities_filter_contexts**](docs/EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint +*EntitiesApi* | [**search_entities_filter_views**](docs/EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint +*EntitiesApi* | [**search_entities_knowledge_recommendations**](docs/EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint +*EntitiesApi* | [**search_entities_labels**](docs/EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint +*EntitiesApi* | [**search_entities_memory_items**](docs/EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint +*EntitiesApi* | [**search_entities_metrics**](docs/EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint +*EntitiesApi* | [**search_entities_parameters**](docs/EntitiesApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint +*EntitiesApi* | [**search_entities_user_data_filters**](docs/EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint +*EntitiesApi* | [**search_entities_visualization_objects**](docs/EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint +*EntitiesApi* | [**search_entities_workspace_data_filter_settings**](docs/EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint +*EntitiesApi* | [**search_entities_workspace_data_filters**](docs/EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint +*EntitiesApi* | [**search_entities_workspace_settings**](docs/EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint *EntitiesApi* | [**update_entity**](docs/EntitiesApi.md#update_entity) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity (Removed) *EntitiesApi* | [**update_entity_agents**](docs/EntitiesApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity *EntitiesApi* | [**update_entity_analytical_dashboards**](docs/EntitiesApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards @@ -1308,7 +1325,7 @@ Class | Method | HTTP request | Description *ExportDefinitionControllerApi* | [**get_all_entities_export_definitions**](docs/ExportDefinitionControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions *ExportDefinitionControllerApi* | [**get_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition *ExportDefinitionControllerApi* | [**patch_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -*ExportDefinitionControllerApi* | [**search_entities_export_definitions**](docs/ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +*ExportDefinitionControllerApi* | [**search_entities_export_definitions**](docs/ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint *ExportDefinitionControllerApi* | [**update_entity_export_definitions**](docs/ExportDefinitionControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition *ExportTemplateControllerApi* | [**create_entity_export_templates**](docs/ExportTemplateControllerApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *ExportTemplateControllerApi* | [**delete_entity_export_templates**](docs/ExportTemplateControllerApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity @@ -1318,21 +1335,21 @@ Class | Method | HTTP request | Description *ExportTemplateControllerApi* | [**update_entity_export_templates**](docs/ExportTemplateControllerApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity *FactControllerApi* | [**get_all_entities_facts**](docs/FactControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts *FactControllerApi* | [**get_entity_facts**](docs/FactControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -*FactControllerApi* | [**patch_entity_facts**](docs/FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -*FactControllerApi* | [**search_entities_facts**](docs/FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +*FactControllerApi* | [**patch_entity_facts**](docs/FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact +*FactControllerApi* | [**search_entities_facts**](docs/FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint *FilterContextControllerApi* | [**create_entity_filter_contexts**](docs/FilterContextControllerApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context *FilterContextControllerApi* | [**delete_entity_filter_contexts**](docs/FilterContextControllerApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context *FilterContextControllerApi* | [**get_all_entities_filter_contexts**](docs/FilterContextControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context *FilterContextControllerApi* | [**get_entity_filter_contexts**](docs/FilterContextControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context *FilterContextControllerApi* | [**patch_entity_filter_contexts**](docs/FilterContextControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -*FilterContextControllerApi* | [**search_entities_filter_contexts**](docs/FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +*FilterContextControllerApi* | [**search_entities_filter_contexts**](docs/FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint *FilterContextControllerApi* | [**update_entity_filter_contexts**](docs/FilterContextControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context *FilterViewControllerApi* | [**create_entity_filter_views**](docs/FilterViewControllerApi.md#create_entity_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews | Post Filter views *FilterViewControllerApi* | [**delete_entity_filter_views**](docs/FilterViewControllerApi.md#delete_entity_filter_views) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Delete Filter view *FilterViewControllerApi* | [**get_all_entities_filter_views**](docs/FilterViewControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views *FilterViewControllerApi* | [**get_entity_filter_views**](docs/FilterViewControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view *FilterViewControllerApi* | [**patch_entity_filter_views**](docs/FilterViewControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view -*FilterViewControllerApi* | [**search_entities_filter_views**](docs/FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +*FilterViewControllerApi* | [**search_entities_filter_views**](docs/FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint *FilterViewControllerApi* | [**update_entity_filter_views**](docs/FilterViewControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *FiscalCalendarControllerApi* | [**get_all_entities_fiscal_calendars**](docs/FiscalCalendarControllerApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars *FiscalCalendarControllerApi* | [**get_entity_fiscal_calendars**](docs/FiscalCalendarControllerApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar @@ -1358,12 +1375,12 @@ Class | Method | HTTP request | Description *KnowledgeRecommendationControllerApi* | [**get_all_entities_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations *KnowledgeRecommendationControllerApi* | [**get_entity_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation *KnowledgeRecommendationControllerApi* | [**patch_entity_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -*KnowledgeRecommendationControllerApi* | [**search_entities_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +*KnowledgeRecommendationControllerApi* | [**search_entities_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint *KnowledgeRecommendationControllerApi* | [**update_entity_knowledge_recommendations**](docs/KnowledgeRecommendationControllerApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation *LabelControllerApi* | [**get_all_entities_labels**](docs/LabelControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels *LabelControllerApi* | [**get_entity_labels**](docs/LabelControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label -*LabelControllerApi* | [**patch_entity_labels**](docs/LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -*LabelControllerApi* | [**search_entities_labels**](docs/LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) +*LabelControllerApi* | [**patch_entity_labels**](docs/LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label +*LabelControllerApi* | [**search_entities_labels**](docs/LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint *LayoutApi* | [**delete_data_source_statistics**](docs/LayoutApi.md#delete_data_source_statistics) | **DELETE** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Delete stored physical statistics for a data source *LayoutApi* | [**get_agents_layout**](docs/LayoutApi.md#get_agents_layout) | **GET** /api/v1/layout/agents | Get all AI agent configurations layout *LayoutApi* | [**get_analytics_model**](docs/LayoutApi.md#get_analytics_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Get analytics model @@ -1424,14 +1441,14 @@ Class | Method | HTTP request | Description *MemoryItemControllerApi* | [**get_all_entities_memory_items**](docs/MemoryItemControllerApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items *MemoryItemControllerApi* | [**get_entity_memory_items**](docs/MemoryItemControllerApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item *MemoryItemControllerApi* | [**patch_entity_memory_items**](docs/MemoryItemControllerApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item -*MemoryItemControllerApi* | [**search_entities_memory_items**](docs/MemoryItemControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +*MemoryItemControllerApi* | [**search_entities_memory_items**](docs/MemoryItemControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint *MemoryItemControllerApi* | [**update_entity_memory_items**](docs/MemoryItemControllerApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item *MetricControllerApi* | [**create_entity_metrics**](docs/MetricControllerApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics *MetricControllerApi* | [**delete_entity_metrics**](docs/MetricControllerApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric *MetricControllerApi* | [**get_all_entities_metrics**](docs/MetricControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics *MetricControllerApi* | [**get_entity_metrics**](docs/MetricControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric *MetricControllerApi* | [**patch_entity_metrics**](docs/MetricControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -*MetricControllerApi* | [**search_entities_metrics**](docs/MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +*MetricControllerApi* | [**search_entities_metrics**](docs/MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint *MetricControllerApi* | [**update_entity_metrics**](docs/MetricControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric *NotificationChannelControllerApi* | [**create_entity_notification_channels**](docs/NotificationChannelControllerApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities *NotificationChannelControllerApi* | [**delete_entity_notification_channels**](docs/NotificationChannelControllerApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity @@ -1467,7 +1484,7 @@ Class | Method | HTTP request | Description *ParameterControllerApi* | [**get_all_entities_parameters**](docs/ParameterControllerApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters *ParameterControllerApi* | [**get_entity_parameters**](docs/ParameterControllerApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter *ParameterControllerApi* | [**patch_entity_parameters**](docs/ParameterControllerApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter -*ParameterControllerApi* | [**search_entities_parameters**](docs/ParameterControllerApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) +*ParameterControllerApi* | [**search_entities_parameters**](docs/ParameterControllerApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint *ParameterControllerApi* | [**update_entity_parameters**](docs/ParameterControllerApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter *ReportControllerApi* | [**create_entity_reports**](docs/ReportControllerApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report *ReportControllerApi* | [**delete_entity_reports**](docs/ReportControllerApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report @@ -1504,7 +1521,7 @@ Class | Method | HTTP request | Description *UserDataFilterControllerApi* | [**get_all_entities_user_data_filters**](docs/UserDataFilterControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters *UserDataFilterControllerApi* | [**get_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter *UserDataFilterControllerApi* | [**patch_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter -*UserDataFilterControllerApi* | [**search_entities_user_data_filters**](docs/UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +*UserDataFilterControllerApi* | [**search_entities_user_data_filters**](docs/UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint *UserDataFilterControllerApi* | [**update_entity_user_data_filters**](docs/UserDataFilterControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter *UserGroupControllerApi* | [**create_entity_user_groups**](docs/UserGroupControllerApi.md#create_entity_user_groups) | **POST** /api/v1/entities/userGroups | Post User Group entities *UserGroupControllerApi* | [**delete_entity_user_groups**](docs/UserGroupControllerApi.md#delete_entity_user_groups) | **DELETE** /api/v1/entities/userGroups/{id} | Delete UserGroup entity @@ -1524,7 +1541,7 @@ Class | Method | HTTP request | Description *VisualizationObjectControllerApi* | [**get_all_entities_visualization_objects**](docs/VisualizationObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects *VisualizationObjectControllerApi* | [**get_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object *VisualizationObjectControllerApi* | [**patch_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -*VisualizationObjectControllerApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +*VisualizationObjectControllerApi* | [**search_entities_visualization_objects**](docs/VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint *VisualizationObjectControllerApi* | [**update_entity_visualization_objects**](docs/VisualizationObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object *WorkspaceColorPaletteControllerApi* | [**create_entity_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette *WorkspaceColorPaletteControllerApi* | [**delete_entity_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette @@ -1543,14 +1560,14 @@ Class | Method | HTTP request | Description *WorkspaceDataFilterControllerApi* | [**get_all_entities_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters *WorkspaceDataFilterControllerApi* | [**get_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter *WorkspaceDataFilterControllerApi* | [**patch_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -*WorkspaceDataFilterControllerApi* | [**search_entities_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +*WorkspaceDataFilterControllerApi* | [**search_entities_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint *WorkspaceDataFilterControllerApi* | [**update_entity_workspace_data_filters**](docs/WorkspaceDataFilterControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter *WorkspaceDataFilterSettingControllerApi* | [**create_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters *WorkspaceDataFilterSettingControllerApi* | [**delete_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter *WorkspaceDataFilterSettingControllerApi* | [**get_all_entities_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters *WorkspaceDataFilterSettingControllerApi* | [**get_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter *WorkspaceDataFilterSettingControllerApi* | [**patch_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter -*WorkspaceDataFilterSettingControllerApi* | [**search_entities_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +*WorkspaceDataFilterSettingControllerApi* | [**search_entities_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint *WorkspaceDataFilterSettingControllerApi* | [**update_entity_workspace_data_filter_settings**](docs/WorkspaceDataFilterSettingControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter *WorkspaceExportTemplateControllerApi* | [**create_entity_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template *WorkspaceExportTemplateControllerApi* | [**delete_entity_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template @@ -1563,7 +1580,7 @@ Class | Method | HTTP request | Description *WorkspaceSettingControllerApi* | [**get_all_entities_workspace_settings**](docs/WorkspaceSettingControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces *WorkspaceSettingControllerApi* | [**get_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace *WorkspaceSettingControllerApi* | [**patch_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -*WorkspaceSettingControllerApi* | [**search_entities_workspace_settings**](docs/WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +*WorkspaceSettingControllerApi* | [**search_entities_workspace_settings**](docs/WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint *WorkspaceSettingControllerApi* | [**update_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace *WorkspaceThemeControllerApi* | [**create_entity_workspace_themes**](docs/WorkspaceThemeControllerApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme *WorkspaceThemeControllerApi* | [**delete_entity_workspace_themes**](docs/WorkspaceThemeControllerApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme @@ -1716,6 +1733,8 @@ Class | Method | HTTP request | Description - [ComparisonWrapper](docs/ComparisonWrapper.md) - [CompoundMeasureValueFilter](docs/CompoundMeasureValueFilter.md) - [CompoundMeasureValueFilterCompoundMeasureValueFilter](docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md) + - [ComputationProfile](docs/ComputationProfile.md) + - [ComputationProfileSource](docs/ComputationProfileSource.md) - [ComputedAttributePermissions](docs/ComputedAttributePermissions.md) - [ComputedAttributePermissionsAssignment](docs/ComputedAttributePermissionsAssignment.md) - [ComputedAttributePermissionsForAssignee](docs/ComputedAttributePermissionsForAssignee.md) @@ -1792,6 +1811,8 @@ Class | Method | HTTP request | Description - [DatasetReferenceIdentifier](docs/DatasetReferenceIdentifier.md) - [DatasetWorkspaceDataFilterIdentifier](docs/DatasetWorkspaceDataFilterIdentifier.md) - [DateFilter](docs/DateFilter.md) + - [DateRangeParameterDefinition](docs/DateRangeParameterDefinition.md) + - [DateRangeParameterValue](docs/DateRangeParameterValue.md) - [DateValue](docs/DateValue.md) - [DeclarativeAgent](docs/DeclarativeAgent.md) - [DeclarativeAgents](docs/DeclarativeAgents.md) @@ -1844,6 +1865,7 @@ Class | Method | HTTP request | Description - [DeclarativeLdm](docs/DeclarativeLdm.md) - [DeclarativeMemoryItem](docs/DeclarativeMemoryItem.md) - [DeclarativeMetric](docs/DeclarativeMetric.md) + - [DeclarativeMetricExtension](docs/DeclarativeMetricExtension.md) - [DeclarativeMetricPermissionAssignment](docs/DeclarativeMetricPermissionAssignment.md) - [DeclarativeMetricPermissionForAssignee](docs/DeclarativeMetricPermissionForAssignee.md) - [DeclarativeMetricPermissionForAssigneeRule](docs/DeclarativeMetricPermissionForAssigneeRule.md) @@ -1885,6 +1907,7 @@ Class | Method | HTTP request | Description - [DeclarativeUsers](docs/DeclarativeUsers.md) - [DeclarativeUsersUserGroups](docs/DeclarativeUsersUserGroups.md) - [DeclarativeVisualizationObject](docs/DeclarativeVisualizationObject.md) + - [DeclarativeVisualizationObjectExtension](docs/DeclarativeVisualizationObjectExtension.md) - [DeclarativeVisualizationObjectPermissionAssignment](docs/DeclarativeVisualizationObjectPermissionAssignment.md) - [DeclarativeVisualizationObjectPermissionForAssignee](docs/DeclarativeVisualizationObjectPermissionForAssignee.md) - [DeclarativeVisualizationObjectPermissionForAssigneeRule](docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md) @@ -1988,6 +2011,7 @@ Class | Method | HTTP request | Description - [GetDocumentExport202ResponseInner](docs/GetDocumentExport202ResponseInner.md) - [GetQualityIssuesResponse](docs/GetQualityIssuesResponse.md) - [GetServiceStatusResponse](docs/GetServiceStatusResponse.md) + - [GoodDataAiProviderConfig](docs/GoodDataAiProviderConfig.md) - [GrainIdentifier](docs/GrainIdentifier.md) - [GrantedPermission](docs/GrantedPermission.md) - [GranularitiesFormatting](docs/GranularitiesFormatting.md) @@ -2845,6 +2869,10 @@ Class | Method | HTTP request | Description - [LocalizationDataStatistics](docs/LocalizationDataStatistics.md) - [LocalizationDefault](docs/LocalizationDefault.md) - [LocalizationDefaults](docs/LocalizationDefaults.md) + - [LocalizationIssue](docs/LocalizationIssue.md) + - [LocalizationIssueWorkspace](docs/LocalizationIssueWorkspace.md) + - [LocalizationIssueWorkspaces](docs/LocalizationIssueWorkspaces.md) + - [LocalizationIssues](docs/LocalizationIssues.md) - [LocalizationMetadataStatistics](docs/LocalizationMetadataStatistics.md) - [LocalizationResolvedValue](docs/LocalizationResolvedValue.md) - [LocalizationResolvedValues](docs/LocalizationResolvedValues.md) @@ -2853,6 +2881,8 @@ Class | Method | HTTP request | Description - [LocalizationSourceCounts](docs/LocalizationSourceCounts.md) - [LocalizationStatistics](docs/LocalizationStatistics.md) - [LocalizationStatisticsLocale](docs/LocalizationStatisticsLocale.md) + - [LocalizationStatisticsTranslatedLocale](docs/LocalizationStatisticsTranslatedLocale.md) + - [LocalizationStatisticsWorkspace](docs/LocalizationStatisticsWorkspace.md) - [LocalizationUsage](docs/LocalizationUsage.md) - [LocalizationUsageUser](docs/LocalizationUsageUser.md) - [LocalizationUsageUsers](docs/LocalizationUsageUsers.md) @@ -2932,6 +2962,8 @@ Class | Method | HTTP request | Description - [ParameterDefinition](docs/ParameterDefinition.md) - [ParameterItem](docs/ParameterItem.md) - [ParameterValue](docs/ParameterValue.md) + - [ParameterizedDateFilter](docs/ParameterizedDateFilter.md) + - [ParameterizedDateFilterParameterizedDateFilter](docs/ParameterizedDateFilterParameterizedDateFilter.md) - [PdfTableStyle](docs/PdfTableStyle.md) - [PdfTableStyleProperty](docs/PdfTableStyleProperty.md) - [PdmLdmRequest](docs/PdmLdmRequest.md) @@ -3155,6 +3187,8 @@ Class | Method | HTTP request | Description - [UserManagementWorkspacePermissionAssignment](docs/UserManagementWorkspacePermissionAssignment.md) - [UserPermission](docs/UserPermission.md) - [ValidateByItem](docs/ValidateByItem.md) + - [ValidateEmbeddingOriginRequest](docs/ValidateEmbeddingOriginRequest.md) + - [ValidateEmbeddingOriginResponse](docs/ValidateEmbeddingOriginResponse.md) - [ValidityPeriodCacheRetention](docs/ValidityPeriodCacheRetention.md) - [Value](docs/Value.md) - [VisibleFilter](docs/VisibleFilter.md) diff --git a/gooddata-api-client/docs/AILakeApi.md b/gooddata-api-client/docs/AILakeApi.md index c7ee88978..d9da48c71 100644 --- a/gooddata-api-client/docs/AILakeApi.md +++ b/gooddata-api-client/docs/AILakeApi.md @@ -15,6 +15,7 @@ Method | HTTP request | Description [**list_ai_lake_object_storages**](AILakeApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages [**list_ai_lake_services**](AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services [**provision_ai_lake_database_instance**](AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance +[**refresh_ai_lake_data_source**](AILakeApi.md#refresh_ai_lake_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh | (BETA) Refresh an AI Lake data source [**remove_ai_lake_database_data_source**](AILakeApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance [**run_ai_lake_service_command**](AILakeApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command [**update_ai_lake_database_data_source**](AILakeApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance @@ -842,6 +843,83 @@ 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) +# **refresh_ai_lake_data_source** +> refresh_ai_lake_data_source(instance_id, data_source_id) + +(BETA) Refresh an AI Lake data source + +(BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = ai_lake_api.AILakeApi(api_client) + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + data_source_id = "dataSourceId_example" # str | Data source identifier. + operation_id = "operation-id_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + # (BETA) Refresh an AI Lake data source + api_instance.refresh_ai_lake_data_source(instance_id, data_source_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->refresh_ai_lake_data_source: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Refresh an AI Lake data source + api_instance.refresh_ai_lake_data_source(instance_id, data_source_id, operation_id=operation_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeApi->refresh_ai_lake_data_source: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | + **data_source_id** | **str**| Data source identifier. | + **operation_id** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Refresh scheduled. | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| + +[[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) + # **remove_ai_lake_database_data_source** > RemoveDatabaseDataSourceResponse remove_ai_lake_database_data_source(instance_id, data_source_id) diff --git a/gooddata-api-client/docs/AILakeDatabasesApi.md b/gooddata-api-client/docs/AILakeDatabasesApi.md index 694ce0344..91684c7ce 100644 --- a/gooddata-api-client/docs/AILakeDatabasesApi.md +++ b/gooddata-api-client/docs/AILakeDatabasesApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**list_ai_lake_database_instances**](AILakeDatabasesApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances [**list_ai_lake_object_storages**](AILakeDatabasesApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages [**provision_ai_lake_database_instance**](AILakeDatabasesApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance +[**refresh_ai_lake_data_source**](AILakeDatabasesApi.md#refresh_ai_lake_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh | (BETA) Refresh an AI Lake data source [**remove_ai_lake_database_data_source**](AILakeDatabasesApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance [**update_ai_lake_database_data_source**](AILakeDatabasesApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance @@ -630,6 +631,83 @@ 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) +# **refresh_ai_lake_data_source** +> refresh_ai_lake_data_source(instance_id, data_source_id) + +(BETA) Refresh an AI Lake data source + +(BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_databases_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + data_source_id = "dataSourceId_example" # str | Data source identifier. + operation_id = "operation-id_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + # (BETA) Refresh an AI Lake data source + api_instance.refresh_ai_lake_data_source(instance_id, data_source_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeDatabasesApi->refresh_ai_lake_data_source: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Refresh an AI Lake data source + api_instance.refresh_ai_lake_data_source(instance_id, data_source_id, operation_id=operation_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeDatabasesApi->refresh_ai_lake_data_source: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | + **data_source_id** | **str**| Data source identifier. | + **operation_id** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Refresh scheduled. | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| + +[[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) + # **remove_ai_lake_database_data_source** > RemoveDatabaseDataSourceResponse remove_ai_lake_database_data_source(instance_id, data_source_id) diff --git a/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md index 0ef107fba..fd207a64b 100644 --- a/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md @@ -1,6 +1,6 @@ # AbsoluteGranularityDateFilter -An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. +An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'. ## Properties Name | Type | Description | Notes diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index f09128a59..c68d41f1e 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -31,13 +31,13 @@ Method | HTTP request | Description [**compute_report_for_visualization_object**](ActionsApi.md#compute_report_for_visualization_object) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute | (BETA) Executes a visualization object and returns link to the result [**compute_valid_descendants**](ActionsApi.md#compute_valid_descendants) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants | (BETA) Valid descendants [**compute_valid_objects**](ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects -[**computed_attribute_permissions**](ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions +[**computed_attribute_permissions**](ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | Get Computed Attribute Permissions [**convert_geo_file**](ActionsApi.md#convert_geo_file) | **POST** /api/v1/actions/customGeoCollection/convert | Convert a geo file to GeoParquet format [**create_dashboard_export_request**](ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request [**create_document_export**](ActionsApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request [**create_image_export**](ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request [**create_pdf_export**](ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request -[**create_raw_export**](ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request +[**create_raw_export**](ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | Create raw export request [**create_report_export**](ActionsApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request [**create_slides_export**](ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request [**create_tabular_export**](ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request @@ -67,7 +67,7 @@ Method | HTTP request | Description [**get_notifications**](ActionsApi.md#get_notifications) | **GET** /api/v1/actions/notifications | Get latest notifications. [**get_quality_issues**](ActionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues [**get_quality_issues_calculation_status**](ActionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status -[**get_raw_export**](ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_raw_export**](ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | Retrieve exported files [**get_report_export**](ActionsApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files [**get_report_export_metadata**](ActionsApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context [**get_slides_export**](ActionsApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files @@ -89,23 +89,25 @@ Method | HTTP request | Description [**list_workspace_user_groups**](ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | [**list_workspace_users**](ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | [**manage_attribute_permissions**](ActionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute -[**manage_computed_attribute_permissions**](ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute +[**manage_computed_attribute_permissions**](ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | Manage Permissions for a Computed Attribute [**manage_dashboard_permissions**](ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard [**manage_data_source_permissions**](ActionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source [**manage_fact_permissions**](ActionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact [**manage_label_permissions**](ActionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label -[**manage_metric_permissions**](ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric +[**manage_metric_permissions**](ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | Manage Permissions for a Metric [**manage_organization_permissions**](ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization -[**manage_visualization_permissions**](ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization +[**manage_visualization_permissions**](ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | Manage Permissions for a Visualization [**manage_workspace_permissions**](ActionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace [**mark_as_read_notification**](ActionsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. [**mark_as_read_notification_all**](ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. [**memory_created_by_users**](ActionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users -[**metric_permissions**](ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions -[**organization_localization_statistics**](ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. -[**organization_localization_usage**](ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. -[**organization_localization_usage_users**](ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. -[**organization_localization_usage_workspaces**](ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. +[**metric_permissions**](ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | Get Metric Permissions +[**organization_localization_issue_workspaces**](ActionsApi.md#organization_localization_issue_workspaces) | **GET** /api/v1/actions/organization/localization/issues/workspaces | (BETA) Workspaces with a localization issue. +[**organization_localization_issues**](ActionsApi.md#organization_localization_issues) | **GET** /api/v1/actions/organization/localization/issues | (BETA) Localization issues of the organization. +[**organization_localization_statistics**](ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | Languages with translations in the organization. +[**organization_localization_usage**](ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | Languages used in the organization. +[**organization_localization_usage_users**](ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | Users who set a language themselves. +[**organization_localization_usage_workspaces**](ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | Workspaces that use a language. [**outlier_detection**](ActionsApi.md#outlier_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers | (BETA) Outlier Detection [**outlier_detection_result**](ActionsApi.md#outlier_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId} | (BETA) Outlier Detection Result [**overridden_child_entities**](ActionsApi.md#overridden_child_entities) | **GET** /api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities | Finds identifier overrides in workspace hierarchy. @@ -136,6 +138,7 @@ Method | HTTP request | Description [**set_certification**](ActionsApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification [**set_translations**](ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities. [**staging_upload**](ActionsApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area +[**stream_execution_progress**](ActionsApi.md#stream_execution_progress) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId} | (EXPERIMENTAL) Stream the live progress of an AFM execution [**switch_active_identity_provider**](ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider [**sync_metadata**](ActionsApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization [**tags**](ActionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags @@ -156,12 +159,15 @@ Method | HTTP request | Description [**unsubscribe_organization_automations**](ActionsApi.md#unsubscribe_organization_automations) | **POST** /api/v1/actions/organization/automations/unsubscribe | Unsubscribe from selected automations across all workspaces [**unsubscribe_selected_workspace_automations**](ActionsApi.md#unsubscribe_selected_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from selected automations in the workspace [**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace +[**validate_embedding_origin**](ActionsApi.md#validate_embedding_origin) | **POST** /api/v1/actions/validateEmbeddingOrigin | Validate an embedding origin. [**validate_llm_endpoint**](ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint (Removed) [**validate_llm_endpoint_by_id**](ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id (Removed) -[**visualization_permissions**](ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions -[**workspace_localization_statistics**](ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. -[**workspace_localization_usage**](ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. -[**workspace_localization_usage_users**](ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. +[**visualization_permissions**](ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | Get Visualization Permissions +[**workspace_localization_issues**](ActionsApi.md#workspace_localization_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/issues | (BETA) Localization issues of the workspace. +[**workspace_localization_statistics**](ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | Languages with translations in the workspace. +[**workspace_localization_usage**](ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | Languages used in the workspace. +[**workspace_localization_usage_child_workspaces**](ActionsApi.md#workspace_localization_usage_child_workspaces) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces | (BETA) Workspaces below the workspace that use a language. +[**workspace_localization_usage_users**](ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | Workspace members who get a language. [**workspace_resolve_all_settings**](ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. [**workspace_resolve_settings**](ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. @@ -2375,7 +2381,7 @@ No authorization required # **computed_attribute_permissions** > ComputedAttributePermissions computed_attribute_permissions(workspace_id, computed_attribute_id) -(BETA) Get Computed Attribute Permissions +Get Computed Attribute Permissions ### Example @@ -2402,7 +2408,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Computed Attribute Permissions + # Get Computed Attribute Permissions api_response = api_instance.computed_attribute_permissions(workspace_id, computed_attribute_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -2882,9 +2888,9 @@ No authorization required # **create_raw_export** > ExportResponse create_raw_export(workspace_id, raw_export_request) -(EXPERIMENTAL) Create raw export request +Create raw export request -Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. +A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. ### Example @@ -2980,7 +2986,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Create raw export request + # Create raw export request api_response = api_instance.create_raw_export(workspace_id, raw_export_request) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -5382,9 +5388,9 @@ No authorization required # **get_raw_export** > file_type get_raw_export(workspace_id, export_id) -(EXPERIMENTAL) Retrieve exported files +Retrieve exported files -Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. +After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -5410,7 +5416,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Retrieve exported files + # Retrieve exported files api_response = api_instance.get_raw_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -7017,7 +7023,7 @@ No authorization required # **manage_computed_attribute_permissions** > manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) -(BETA) Manage Permissions for a Computed Attribute +Manage Permissions for a Computed Attribute ### Example @@ -7047,7 +7053,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Computed Attribute + # Manage Permissions for a Computed Attribute api_instance.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->manage_computed_attribute_permissions: %s\n" % e) @@ -7375,7 +7381,7 @@ No authorization required # **manage_metric_permissions** > manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) -(BETA) Manage Permissions for a Metric +Manage Permissions for a Metric ### Example @@ -7405,7 +7411,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Metric + # Manage Permissions for a Metric api_instance.manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->manage_metric_permissions: %s\n" % e) @@ -7521,7 +7527,7 @@ No authorization required # **manage_visualization_permissions** > manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) -(BETA) Manage Permissions for a Visualization +Manage Permissions for a Visualization ### Example @@ -7551,7 +7557,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Visualization + # Manage Permissions for a Visualization api_instance.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->manage_visualization_permissions: %s\n" % e) @@ -7870,7 +7876,7 @@ No authorization required # **metric_permissions** > MetricPermissions metric_permissions(workspace_id, metric_id) -(BETA) Get Metric Permissions +Get Metric Permissions ### Example @@ -7897,7 +7903,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Metric Permissions + # Get Metric Permissions api_response = api_instance.metric_permissions(workspace_id, metric_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -7926,6 +7932,153 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **organization_localization_issue_workspaces** +> LocalizationIssueWorkspaces organization_localization_issue_workspaces(type, locale) + +(BETA) Workspaces with a localization issue. + +(BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_issue_workspaces import LocalizationIssueWorkspaces +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + type = "METADATA_MISSING_TRANSLATION" # str | The type of the issue. + locale = "de-DE" # str | The language of the issue. + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspaces with a localization issue. + api_response = api_instance.organization_localization_issue_workspaces(type, locale) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->organization_localization_issue_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspaces with a localization issue. + api_response = api_instance.organization_localization_issue_workspaces(type, locale, name=name, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->organization_localization_issue_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| The type of the issue. | + **locale** | **str**| The language of the issue. | + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationIssueWorkspaces**](LocalizationIssueWorkspaces.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **organization_localization_issues** +> LocalizationIssues organization_localization_issues() + +(BETA) Localization issues of the organization. + +(BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_issues import LocalizationIssues +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Localization issues of the organization. + api_response = api_instance.organization_localization_issues() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->organization_localization_issues: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LocalizationIssues**](LocalizationIssues.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -7937,9 +8090,9 @@ No authorization required # **organization_localization_statistics** > LocalizationStatistics organization_localization_statistics() -(BETA) Languages with translations in the organization. +Languages with translations in the organization. -(BETA) Lists the languages that have at least one translation, separately for each kind of translation. +Lists the languages that have at least one translation, separately for each kind of translation. ### Example @@ -7964,7 +8117,7 @@ with gooddata_api_client.ApiClient() as api_client: # example, this endpoint has no required or optional parameters try: - # (BETA) Languages with translations in the organization. + # Languages with translations in the organization. api_response = api_instance.organization_localization_statistics() pprint(api_response) except gooddata_api_client.ApiException as e: @@ -8000,9 +8153,9 @@ No authorization required # **organization_localization_usage** > LocalizationUsage organization_localization_usage() -(BETA) Languages used in the organization. +Languages used in the organization. -(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. +Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. ### Example @@ -8027,7 +8180,7 @@ with gooddata_api_client.ApiClient() as api_client: # example, this endpoint has no required or optional parameters try: - # (BETA) Languages used in the organization. + # Languages used in the organization. api_response = api_instance.organization_localization_usage() pprint(api_response) except gooddata_api_client.ApiException as e: @@ -8063,9 +8216,9 @@ No authorization required # **organization_localization_usage_users** > LocalizationUsageUsers organization_localization_usage_users() -(BETA) Users who set a language themselves. +Users who set a language themselves. -(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language. ### Example @@ -8097,7 +8250,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Users who set a language themselves. + # Users who set a language themselves. api_response = api_instance.organization_localization_usage_users(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -8141,9 +8294,9 @@ No authorization required # **organization_localization_usage_workspaces** > LocalizationUsageWorkspaces organization_localization_usage_workspaces() -(BETA) Workspaces that use a language. +Workspaces that use a language. -(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. ### Example @@ -8175,7 +8328,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Workspaces that use a language. + # Workspaces that use a language. api_response = api_instance.organization_localization_usage_workspaces(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -10487,6 +10640,74 @@ 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) +# **stream_execution_progress** +> [dict] stream_execution_progress(workspace_id, execution_id) + +(EXPERIMENTAL) Stream the live progress of an AFM execution + +Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + execution_id = "executionId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Stream the live progress of an AFM execution + api_response = api_instance.stream_execution_progress(workspace_id, execution_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->stream_execution_progress: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **execution_id** | **str**| | + +### Return type + +**[dict]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/event-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + # **switch_active_identity_provider** > switch_active_identity_provider(switch_identity_provider_request) @@ -12247,6 +12468,76 @@ 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) +# **validate_embedding_origin** +> ValidateEmbeddingOriginResponse validate_embedding_origin(validate_embedding_origin_request) + +Validate an embedding origin. + +Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.validate_embedding_origin_request import ValidateEmbeddingOriginRequest +from gooddata_api_client.model.validate_embedding_origin_response import ValidateEmbeddingOriginResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + validate_embedding_origin_request = ValidateEmbeddingOriginRequest( + origin="https://app.example.com", + ) # ValidateEmbeddingOriginRequest | + + # example passing only required values which don't have defaults set + try: + # Validate an embedding origin. + api_response = api_instance.validate_embedding_origin(validate_embedding_origin_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->validate_embedding_origin: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **validate_embedding_origin_request** | [**ValidateEmbeddingOriginRequest**](ValidateEmbeddingOriginRequest.md)| | + +### Return type + +[**ValidateEmbeddingOriginResponse**](ValidateEmbeddingOriginResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Whether the origin may embed the application. | - | + +[[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) + # **validate_llm_endpoint** > validate_llm_endpoint() @@ -12376,7 +12667,7 @@ No authorization required # **visualization_permissions** > VisualizationPermissions visualization_permissions(workspace_id, visualization_object_id) -(BETA) Get Visualization Permissions +Get Visualization Permissions ### Example @@ -12403,7 +12694,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Visualization Permissions + # Get Visualization Permissions api_response = api_instance.visualization_permissions(workspace_id, visualization_object_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -12432,6 +12723,73 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **workspace_localization_issues** +> LocalizationIssues workspace_localization_issues(workspace_id) + +(BETA) Localization issues of the workspace. + +(BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_issues import LocalizationIssues +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Localization issues of the workspace. + api_response = api_instance.workspace_localization_issues(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_issues: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**LocalizationIssues**](LocalizationIssues.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -12443,9 +12801,9 @@ No authorization required # **workspace_localization_statistics** > LocalizationStatistics workspace_localization_statistics(workspace_id) -(BETA) Languages with translations in the workspace. +Languages with translations in the workspace. -(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. +Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent. ### Example @@ -12468,14 +12826,24 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) workspace_id = "workspaceId_example" # str | + include_coverage = True # bool | (BETA) Adds translation counts for the workspace and each parent, root first. (optional) # example passing only required values which don't have defaults set try: - # (BETA) Languages with translations in the workspace. + # Languages with translations in the workspace. api_response = api_instance.workspace_localization_statistics(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->workspace_localization_statistics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Languages with translations in the workspace. + api_response = api_instance.workspace_localization_statistics(workspace_id, include_coverage=include_coverage) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_statistics: %s\n" % e) ``` @@ -12484,6 +12852,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | + **include_coverage** | **bool**| (BETA) Adds translation counts for the workspace and each parent, root first. | [optional] ### Return type @@ -12510,9 +12879,9 @@ No authorization required # **workspace_localization_usage** > WorkspaceLocalizationUsage workspace_localization_usage(workspace_id) -(BETA) Languages used in the workspace. +Languages used in the workspace. -(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. +Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way. ### Example @@ -12538,7 +12907,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Languages used in the workspace. + # Languages used in the workspace. api_response = api_instance.workspace_localization_usage(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -12566,6 +12935,94 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **workspace_localization_usage_child_workspaces** +> LocalizationUsageWorkspaces workspace_localization_usage_child_workspaces(workspace_id) + +(BETA) Workspaces below the workspace that use a language. + +(BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + value = "de-DE" # str | Language tag that the workspace gets. (optional) + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "PARENT" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspaces below the workspace that use a language. + api_response = api_instance.workspace_localization_usage_child_workspaces(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_usage_child_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspaces below the workspace that use a language. + api_response = api_instance.workspace_localization_usage_child_workspaces(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_usage_child_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **value** | **str**| Language tag that the workspace gets. | [optional] + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageWorkspaces**](LocalizationUsageWorkspaces.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -12577,9 +13034,9 @@ No authorization required # **workspace_localization_usage_users** > LocalizationUsageUsers workspace_localization_usage_users(workspace_id) -(BETA) Workspace members who get a language. +Workspace members who get a language. -(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language. ### Example @@ -12611,7 +13068,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Workspace members who get a language. + # Workspace members who get a language. api_response = api_instance.workspace_localization_usage_users(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -12620,7 +13077,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Workspace members who get a language. + # Workspace members who get a language. api_response = api_instance.workspace_localization_usage_users(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AggregatedFactControllerApi.md b/gooddata-api-client/docs/AggregatedFactControllerApi.md index df9e4bf81..81a6e71ef 100644 --- a/gooddata-api-client/docs/AggregatedFactControllerApi.md +++ b/gooddata-api-client/docs/AggregatedFactControllerApi.md @@ -6,7 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_aggregated_facts**](AggregatedFactControllerApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | Get all Aggregated Facts [**get_entity_aggregated_facts**](AggregatedFactControllerApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | Get an Aggregated Fact -[**search_entities_aggregated_facts**](AggregatedFactControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) +[**search_entities_aggregated_facts**](AggregatedFactControllerApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint # **get_all_entities_aggregated_facts** @@ -196,7 +196,7 @@ No authorization required # **search_entities_aggregated_facts** > JsonApiAggregatedFactOutList search_entities_aggregated_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -244,7 +244,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -253,7 +253,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md index 96eb6d3d1..01a489d64 100644 --- a/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md +++ b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_analytical_dashboards**](AnalyticalDashboardControllerApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards [**get_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard [**patch_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -[**search_entities_analytical_dashboards**](AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +[**search_entities_analytical_dashboards**](AnalyticalDashboardControllerApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint [**update_entity_analytical_dashboards**](AnalyticalDashboardControllerApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards @@ -465,7 +465,7 @@ No authorization required # **search_entities_analytical_dashboards** > JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -513,7 +513,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -522,7 +522,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index ac830a795..ea77ca6bb 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -377,8 +377,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -605,6 +615,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -693,8 +711,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -759,6 +787,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", diff --git a/gooddata-api-client/docs/AttributeControllerApi.md b/gooddata-api-client/docs/AttributeControllerApi.md index 2842bb706..75976d1a8 100644 --- a/gooddata-api-client/docs/AttributeControllerApi.md +++ b/gooddata-api-client/docs/AttributeControllerApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_attributes**](AttributeControllerApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes [**get_entity_attributes**](AttributeControllerApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -[**patch_entity_attributes**](AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -[**search_entities_attributes**](AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) +[**patch_entity_attributes**](AttributeControllerApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute +[**search_entities_attributes**](AttributeControllerApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint # **get_all_entities_attributes** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_attributes** > JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) -Patch an Attribute (beta) +Patch an Attribute ### Example @@ -262,7 +262,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -271,7 +271,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -314,7 +314,7 @@ No authorization required # **search_entities_attributes** > JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -362,7 +362,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -371,7 +371,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AttributeHierarchiesApi.md b/gooddata-api-client/docs/AttributeHierarchiesApi.md index 762d3a220..5f90c1d3e 100644 --- a/gooddata-api-client/docs/AttributeHierarchiesApi.md +++ b/gooddata-api-client/docs/AttributeHierarchiesApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies [**get_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy [**patch_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -[**search_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +[**search_entities_attribute_hierarchies**](AttributeHierarchiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint [**update_entity_attribute_hierarchies**](AttributeHierarchiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy @@ -463,7 +463,7 @@ No authorization required # **search_entities_attribute_hierarchies** > JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AttributeHierarchyControllerApi.md b/gooddata-api-client/docs/AttributeHierarchyControllerApi.md index 26c3543c0..4796fc11f 100644 --- a/gooddata-api-client/docs/AttributeHierarchyControllerApi.md +++ b/gooddata-api-client/docs/AttributeHierarchyControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_attribute_hierarchies**](AttributeHierarchyControllerApi.md#get_all_entities_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Get all Attribute Hierarchies [**get_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#get_entity_attribute_hierarchies) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Get an Attribute Hierarchy [**patch_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -[**search_entities_attribute_hierarchies**](AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) +[**search_entities_attribute_hierarchies**](AttributeHierarchyControllerApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint [**update_entity_attribute_hierarchies**](AttributeHierarchyControllerApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy @@ -463,7 +463,7 @@ No authorization required # **search_entities_attribute_hierarchies** > JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AttributesApi.md b/gooddata-api-client/docs/AttributesApi.md index 1b86c6eac..0775bf77e 100644 --- a/gooddata-api-client/docs/AttributesApi.md +++ b/gooddata-api-client/docs/AttributesApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_attributes**](AttributesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes [**get_entity_attributes**](AttributesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute -[**patch_entity_attributes**](AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) -[**search_entities_attributes**](AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) +[**patch_entity_attributes**](AttributesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute +[**search_entities_attributes**](AttributesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint # **get_all_entities_attributes** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_attributes** > JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) -Patch an Attribute (beta) +Patch an Attribute ### Example @@ -262,7 +262,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -271,7 +271,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -314,7 +314,7 @@ No authorization required # **search_entities_attributes** > JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -362,7 +362,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -371,7 +371,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AutomationControllerApi.md b/gooddata-api-client/docs/AutomationControllerApi.md index 3a845e532..66e07b09d 100644 --- a/gooddata-api-client/docs/AutomationControllerApi.md +++ b/gooddata-api-client/docs/AutomationControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_automations**](AutomationControllerApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations [**get_entity_automations**](AutomationControllerApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation [**patch_entity_automations**](AutomationControllerApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation -[**search_entities_automations**](AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +[**search_entities_automations**](AutomationControllerApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint [**update_entity_automations**](AutomationControllerApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation @@ -1129,7 +1129,7 @@ No authorization required # **search_entities_automations** > JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1177,7 +1177,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1186,7 +1186,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AutomationResultControllerApi.md b/gooddata-api-client/docs/AutomationResultControllerApi.md index 4dd647601..b914d449b 100644 --- a/gooddata-api-client/docs/AutomationResultControllerApi.md +++ b/gooddata-api-client/docs/AutomationResultControllerApi.md @@ -4,13 +4,13 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**search_entities_automation_results**](AutomationResultControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) +[**search_entities_automation_results**](AutomationResultControllerApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint # **search_entities_automation_results** > JsonApiAutomationResultOutList search_entities_automation_results(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -58,7 +58,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -67,7 +67,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 875c4b94b..2ecdef726 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -15,8 +15,8 @@ Method | HTTP request | Description [**patch_entity_automations**](AutomationsApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation [**pause_organization_automations**](AutomationsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces [**pause_workspace_automations**](AutomationsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace -[**search_entities_automation_results**](AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) -[**search_entities_automations**](AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +[**search_entities_automation_results**](AutomationsApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint +[**search_entities_automations**](AutomationsApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint [**set_automations**](AutomationsApi.md#set_automations) | **PUT** /api/v1/layout/workspaces/{workspaceId}/automations | Set automations [**trigger_automation**](AutomationsApi.md#trigger_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/trigger | Trigger automation. [**trigger_existing_automation**](AutomationsApi.md#trigger_existing_automation) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger | Trigger existing automation. @@ -1594,7 +1594,7 @@ No authorization required # **search_entities_automation_results** > JsonApiAutomationResultOutList search_entities_automation_results(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1642,7 +1642,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1651,7 +1651,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1693,7 +1693,7 @@ No authorization required # **search_entities_automations** > JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1741,7 +1741,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1750,7 +1750,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index f7f804454..b6a0d1436 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -21,6 +21,7 @@ Method | HTTP request | Description [**retrieve_execution_metadata**](ComputationApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata. [**retrieve_result**](ComputationApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result [**retrieve_result_binary**](ComputationApi.md#retrieve_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary | (BETA) Get a single execution result in Apache Arrow File or Stream format +[**stream_execution_progress**](ComputationApi.md#stream_execution_progress) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId} | (EXPERIMENTAL) Stream the live progress of an AFM execution # **cancel_executions** @@ -1687,3 +1688,71 @@ 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) +# **stream_execution_progress** +> [dict] stream_execution_progress(workspace_id, execution_id) + +(EXPERIMENTAL) Stream the live progress of an AFM execution + +Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computation_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = computation_api.ComputationApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + execution_id = "executionId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Stream the live progress of an AFM execution + api_response = api_instance.stream_execution_progress(workspace_id, execution_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputationApi->stream_execution_progress: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **execution_id** | **str**| | + +### Return type + +**[dict]** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/event-stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + diff --git a/gooddata-api-client/docs/ComputationProfile.md b/gooddata-api-client/docs/ComputationProfile.md new file mode 100644 index 000000000..1c67814cd --- /dev/null +++ b/gooddata-api-client/docs/ComputationProfile.md @@ -0,0 +1,19 @@ +# ComputationProfile + +(EXPERIMENTAL) How the result was originally computed. Missing when unknown. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**computed_at** | **int** | | +**sources** | [**[ComputationProfileSource]**](ComputationProfileSource.md) | | +**v** | **int** | | +**finished_at** | **int** | | [optional] +**finished_at_approx** | **str** | | [optional] +**started_at** | **int** | | [optional] +**total_duration_ms** | **int** | | [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/ComputationProfileSource.md b/gooddata-api-client/docs/ComputationProfileSource.md new file mode 100644 index 000000000..942903711 --- /dev/null +++ b/gooddata-api-client/docs/ComputationProfileSource.md @@ -0,0 +1,23 @@ +# ComputationProfileSource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_id** | **str** | | [optional] +**data_source_name** | **str** | | [optional] +**db_duration_ms** | **int** | | [optional] +**finished_at** | **int** | | [optional] +**query_duration_ms** | **int** | | [optional] +**query_finished_at** | **int** | | [optional] +**query_requested_at** | **int** | | [optional] +**query_started_at** | **int** | | [optional] +**result_id** | **str** | | [optional] +**rows** | **int** | | [optional] +**streaming_started_at** | **int** | | [optional] +**total_duration_ms** | **int** | | [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/ComputedAttributeControllerApi.md b/gooddata-api-client/docs/ComputedAttributeControllerApi.md index 9a03b70cb..c3be64c4c 100644 --- a/gooddata-api-client/docs/ComputedAttributeControllerApi.md +++ b/gooddata-api-client/docs/ComputedAttributeControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_computed_attributes**](ComputedAttributeControllerApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes [**get_entity_computed_attributes**](ComputedAttributeControllerApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute [**patch_entity_computed_attributes**](ComputedAttributeControllerApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute -[**search_entities_computed_attributes**](ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +[**search_entities_computed_attributes**](ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint [**update_entity_computed_attributes**](ComputedAttributeControllerApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute @@ -483,7 +483,7 @@ No authorization required # **search_entities_computed_attributes** > JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -531,7 +531,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -540,7 +540,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ComputedAttributesApi.md b/gooddata-api-client/docs/ComputedAttributesApi.md index 732e6e910..9a115bbed 100644 --- a/gooddata-api-client/docs/ComputedAttributesApi.md +++ b/gooddata-api-client/docs/ComputedAttributesApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_computed_attributes**](ComputedAttributesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes [**get_entity_computed_attributes**](ComputedAttributesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute [**patch_entity_computed_attributes**](ComputedAttributesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute -[**search_entities_computed_attributes**](ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +[**search_entities_computed_attributes**](ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint [**update_entity_computed_attributes**](ComputedAttributesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute @@ -483,7 +483,7 @@ No authorization required # **search_entities_computed_attributes** > JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -531,7 +531,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -540,7 +540,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md b/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md index 26cc1d3f8..1b79e3e8b 100644 --- a/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md +++ b/gooddata-api-client/docs/CustomApplicationSettingControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_custom_application_settings**](CustomApplicationSettingControllerApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings [**get_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting [**patch_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting -[**search_entities_custom_application_settings**](CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) +[**search_entities_custom_application_settings**](CustomApplicationSettingControllerApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint [**update_entity_custom_application_settings**](CustomApplicationSettingControllerApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting @@ -437,7 +437,7 @@ No authorization required # **search_entities_custom_application_settings** > JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -485,7 +485,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -494,7 +494,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DashboardPluginControllerApi.md b/gooddata-api-client/docs/DashboardPluginControllerApi.md index d75aacbed..238e68ab1 100644 --- a/gooddata-api-client/docs/DashboardPluginControllerApi.md +++ b/gooddata-api-client/docs/DashboardPluginControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_dashboard_plugins**](DashboardPluginControllerApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins [**get_entity_dashboard_plugins**](DashboardPluginControllerApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin [**patch_entity_dashboard_plugins**](DashboardPluginControllerApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -[**search_entities_dashboard_plugins**](DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +[**search_entities_dashboard_plugins**](DashboardPluginControllerApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint [**update_entity_dashboard_plugins**](DashboardPluginControllerApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin @@ -463,7 +463,7 @@ No authorization required # **search_entities_dashboard_plugins** > JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DashboardsApi.md b/gooddata-api-client/docs/DashboardsApi.md index 5f0a7d25f..00ee151eb 100644 --- a/gooddata-api-client/docs/DashboardsApi.md +++ b/gooddata-api-client/docs/DashboardsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_analytical_dashboards**](DashboardsApi.md#get_all_entities_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Get all Dashboards [**get_entity_analytical_dashboards**](DashboardsApi.md#get_entity_analytical_dashboards) | **GET** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Get a Dashboard [**patch_entity_analytical_dashboards**](DashboardsApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard -[**search_entities_analytical_dashboards**](DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) +[**search_entities_analytical_dashboards**](DashboardsApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint [**update_entity_analytical_dashboards**](DashboardsApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards @@ -465,7 +465,7 @@ No authorization required # **search_entities_analytical_dashboards** > JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -513,7 +513,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -522,7 +522,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DataFiltersApi.md b/gooddata-api-client/docs/DataFiltersApi.md index 4541bf700..687f68b08 100644 --- a/gooddata-api-client/docs/DataFiltersApi.md +++ b/gooddata-api-client/docs/DataFiltersApi.md @@ -20,9 +20,9 @@ Method | HTTP request | Description [**patch_entity_user_data_filters**](DataFiltersApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter [**patch_entity_workspace_data_filter_settings**](DataFiltersApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter [**patch_entity_workspace_data_filters**](DataFiltersApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -[**search_entities_user_data_filters**](DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) -[**search_entities_workspace_data_filter_settings**](DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) -[**search_entities_workspace_data_filters**](DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +[**search_entities_user_data_filters**](DataFiltersApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint +[**search_entities_workspace_data_filter_settings**](DataFiltersApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint +[**search_entities_workspace_data_filters**](DataFiltersApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint [**set_workspace_data_filters_layout**](DataFiltersApi.md#set_workspace_data_filters_layout) | **PUT** /api/v1/layout/workspaceDataFilters | Set all workspace data filters [**update_entity_user_data_filters**](DataFiltersApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter [**update_entity_workspace_data_filter_settings**](DataFiltersApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter @@ -1470,7 +1470,7 @@ No authorization required # **search_entities_user_data_filters** > JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1518,7 +1518,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1527,7 +1527,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1569,7 +1569,7 @@ No authorization required # **search_entities_workspace_data_filter_settings** > JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1617,7 +1617,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1626,7 +1626,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1668,7 +1668,7 @@ No authorization required # **search_entities_workspace_data_filters** > JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1716,7 +1716,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1725,7 +1725,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DatasetControllerApi.md b/gooddata-api-client/docs/DatasetControllerApi.md index e09ccb0be..30d351d1e 100644 --- a/gooddata-api-client/docs/DatasetControllerApi.md +++ b/gooddata-api-client/docs/DatasetControllerApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_datasets**](DatasetControllerApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets [**get_entity_datasets**](DatasetControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -[**patch_entity_datasets**](DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -[**search_entities_datasets**](DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +[**patch_entity_datasets**](DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset +[**search_entities_datasets**](DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint # **get_all_entities_datasets** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_datasets** > JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) -Patch a Dataset (beta) +Patch a Dataset ### Example @@ -242,7 +242,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -251,7 +251,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -294,7 +294,7 @@ No authorization required # **search_entities_datasets** > JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -342,7 +342,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -351,7 +351,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DatasetsApi.md b/gooddata-api-client/docs/DatasetsApi.md index 08d5ab1fc..e5c703a3f 100644 --- a/gooddata-api-client/docs/DatasetsApi.md +++ b/gooddata-api-client/docs/DatasetsApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_datasets**](DatasetsApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets [**get_entity_datasets**](DatasetsApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset -[**patch_entity_datasets**](DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) -[**search_entities_datasets**](DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +[**patch_entity_datasets**](DatasetsApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset +[**search_entities_datasets**](DatasetsApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint # **get_all_entities_datasets** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_datasets** > JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) -Patch a Dataset (beta) +Patch a Dataset ### Example @@ -242,7 +242,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -251,7 +251,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -294,7 +294,7 @@ No authorization required # **search_entities_datasets** > JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -342,7 +342,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -351,7 +351,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DateFilter.md b/gooddata-api-client/docs/DateFilter.md index 8668f0838..283591896 100644 --- a/gooddata-api-client/docs/DateFilter.md +++ b/gooddata-api-client/docs/DateFilter.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) | | [optional] +**parameterized_date_filter** | [**ParameterizedDateFilterParameterizedDateFilter**](ParameterizedDateFilterParameterizedDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] **all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.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/DateRangeParameterDefinition.md b/gooddata-api-client/docs/DateRangeParameterDefinition.md new file mode 100644 index 000000000..8c0b7a13b --- /dev/null +++ b/gooddata-api-client/docs/DateRangeParameterDefinition.md @@ -0,0 +1,13 @@ +# DateRangeParameterDefinition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default_value** | [**DateRangeParameterValue**](DateRangeParameterValue.md) | | +**type** | **str** | The parameter type. | defaults to "DATE_RANGE" +**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/DateRangeParameterValue.md b/gooddata-api-client/docs/DateRangeParameterValue.md new file mode 100644 index 000000000..3b6e42678 --- /dev/null +++ b/gooddata-api-client/docs/DateRangeParameterValue.md @@ -0,0 +1,14 @@ +# DateRangeParameterValue + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**granularity** | **str** | Granularity of the period; determines the format of 'from' and 'to'. | +**_from** | **str** | Start of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the start. | [optional] +**to** | **str** | End of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the end. | [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/DeclarativeAnalyticsLayer.md b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md index 9c8ebe289..412a85f40 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md @@ -14,12 +14,14 @@ Name | Type | Description | Notes **export_definitions** | [**[DeclarativeExportDefinition]**](DeclarativeExportDefinition.md) | A list of export definitions. | [optional] **filter_contexts** | [**[DeclarativeFilterContext]**](DeclarativeFilterContext.md) | A list of filter contexts available in the model. | [optional] **memory_items** | [**[DeclarativeMemoryItem]**](DeclarativeMemoryItem.md) | A list of AI memory items available in the workspace. | [optional] +**metric_extensions** | [**[DeclarativeMetricExtension]**](DeclarativeMetricExtension.md) | A list of metric permissions assigned to a related metric. | [optional] **metrics** | [**[DeclarativeMetric]**](DeclarativeMetric.md) | A list of metrics available in the model. | [optional] **page_templates** | [**[DeclarativePublisherDocumentPageTemplate]**](DeclarativePublisherDocumentPageTemplate.md) | A list of page templates available in the model. | [optional] **parameters** | [**[DeclarativeParameter]**](DeclarativeParameter.md) | A list of parameters available in the model. | [optional] **report_page_layouts** | [**[DeclarativeReportPageLayout]**](DeclarativeReportPageLayout.md) | A list of report page layouts available in the model. | [optional] **report_templates** | [**[DeclarativeReportTemplate]**](DeclarativeReportTemplate.md) | A list of report templates available in the model. | [optional] **reports** | [**[DeclarativeReport]**](DeclarativeReport.md) | A list of reports available in the model. | [optional] +**visualization_object_extensions** | [**[DeclarativeVisualizationObjectExtension]**](DeclarativeVisualizationObjectExtension.md) | A list of visualization object permissions assigned to a related visualization object. | [optional] **visualization_objects** | [**[DeclarativeVisualizationObject]**](DeclarativeVisualizationObject.md) | A list of visualization objects available in the model. | [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/DeclarativeMetricExtension.md b/gooddata-api-client/docs/DeclarativeMetricExtension.md new file mode 100644 index 000000000..f7398aeb0 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeMetricExtension.md @@ -0,0 +1,13 @@ +# DeclarativeMetricExtension + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Metric ID. | +**permissions** | [**[DeclarativeMetricPermissionsInner]**](DeclarativeMetricPermissionsInner.md) | A list of permissions. | +**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/DeclarativePublisherDocumentPageTemplate.md b/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md index 58d71c1d4..483e9661d 100644 --- a/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md +++ b/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md @@ -8,7 +8,11 @@ Name | Type | Description | Notes **id** | **str** | Page template ID. | **title** | **str** | Page template title. | **version** | **str** | Version of the content format. | +**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Page template description. | [optional] +**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **tags** | **[str]** | | [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/DeclarativePublisherDocumentTemplate.md b/gooddata-api-client/docs/DeclarativePublisherDocumentTemplate.md index 9dbf99880..1eb3881b1 100644 --- a/gooddata-api-client/docs/DeclarativePublisherDocumentTemplate.md +++ b/gooddata-api-client/docs/DeclarativePublisherDocumentTemplate.md @@ -8,7 +8,11 @@ Name | Type | Description | Notes **id** | **str** | Document template ID. | **title** | **str** | Document template title. | **version** | **str** | Version of the content format. | +**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Document template description. | [optional] +**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **tags** | **[str]** | | [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/DeclarativeVisualizationObjectExtension.md b/gooddata-api-client/docs/DeclarativeVisualizationObjectExtension.md new file mode 100644 index 000000000..ff40f1c77 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeVisualizationObjectExtension.md @@ -0,0 +1,13 @@ +# DeclarativeVisualizationObjectExtension + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Visualization object ID. | +**permissions** | [**[DeclarativeVisualizationObjectPermissionsInner]**](DeclarativeVisualizationObjectPermissionsInner.md) | A list of permissions. | +**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/DocumentControllerApi.md b/gooddata-api-client/docs/DocumentControllerApi.md index 434c110d9..010721cd0 100644 --- a/gooddata-api-client/docs/DocumentControllerApi.md +++ b/gooddata-api-client/docs/DocumentControllerApi.md @@ -9,6 +9,7 @@ Method | HTTP request | Description [**get_all_entities_documents**](DocumentControllerApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents [**get_entity_documents**](DocumentControllerApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document [**patch_entity_documents**](DocumentControllerApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +[**search_entities_documents**](DocumentControllerApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint [**update_entity_documents**](DocumentControllerApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document @@ -743,6 +744,105 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[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) + +# **search_entities_documents** +> JsonApiPublisherDocumentOutList search_entities_documents(workspace_id, entity_search_body) + +The search endpoint + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->search_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->search_entities_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 154c98809..7e1312b79 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -226,7 +226,7 @@ Method | HTTP request | Description [**patch_entity_agents**](EntitiesApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity [**patch_entity_analytical_dashboards**](EntitiesApi.md#patch_entity_analytical_dashboards) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Patch a Dashboard [**patch_entity_attribute_hierarchies**](EntitiesApi.md#patch_entity_attribute_hierarchies) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Patch an Attribute Hierarchy -[**patch_entity_attributes**](EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) +[**patch_entity_attributes**](EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute [**patch_entity_automations**](EntitiesApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation [**patch_entity_color_palettes**](EntitiesApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette [**patch_entity_computed_attributes**](EntitiesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute @@ -236,18 +236,18 @@ Method | HTTP request | Description [**patch_entity_custom_geo_collections**](EntitiesApi.md#patch_entity_custom_geo_collections) | **PATCH** /api/v1/entities/customGeoCollections/{id} | Patch Custom Geo Collection [**patch_entity_dashboard_plugins**](EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin [**patch_entity_data_sources**](EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity -[**patch_entity_datasets**](EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +[**patch_entity_datasets**](EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset [**patch_entity_document_templates**](EntitiesApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template [**patch_entity_documents**](EntitiesApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document [**patch_entity_export_definitions**](EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition [**patch_entity_export_templates**](EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity -[**patch_entity_facts**](EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) +[**patch_entity_facts**](EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact [**patch_entity_filter_contexts**](EntitiesApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context [**patch_entity_filter_views**](EntitiesApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view [**patch_entity_identity_providers**](EntitiesApi.md#patch_entity_identity_providers) | **PATCH** /api/v1/entities/identityProviders/{id} | Patch Identity Provider [**patch_entity_jwks**](EntitiesApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk [**patch_entity_knowledge_recommendations**](EntitiesApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -[**patch_entity_labels**](EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) +[**patch_entity_labels**](EntitiesApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label [**patch_entity_llm_providers**](EntitiesApi.md#patch_entity_llm_providers) | **PATCH** /api/v1/entities/llmProviders/{id} | Patch LLM Provider entity [**patch_entity_memory_items**](EntitiesApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item [**patch_entity_metrics**](EntitiesApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric @@ -272,30 +272,31 @@ Method | HTTP request | Description [**patch_entity_workspace_settings**](EntitiesApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace [**patch_entity_workspace_themes**](EntitiesApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme [**patch_entity_workspaces**](EntitiesApi.md#patch_entity_workspaces) | **PATCH** /api/v1/entities/workspaces/{id} | Patch Workspace entity -[**search_entities_aggregated_facts**](EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) -[**search_entities_analytical_dashboards**](EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint (beta) -[**search_entities_attribute_hierarchies**](EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint (beta) -[**search_entities_attributes**](EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) -[**search_entities_automation_results**](EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) -[**search_entities_automations**](EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) -[**search_entities_computed_attributes**](EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) -[**search_entities_custom_application_settings**](EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) -[**search_entities_dashboard_plugins**](EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) -[**search_entities_datasets**](EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) -[**search_entities_export_definitions**](EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) -[**search_entities_facts**](EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) -[**search_entities_filter_contexts**](EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) -[**search_entities_filter_views**](EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) -[**search_entities_knowledge_recommendations**](EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) -[**search_entities_labels**](EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) -[**search_entities_memory_items**](EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) -[**search_entities_metrics**](EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) -[**search_entities_parameters**](EntitiesApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) -[**search_entities_user_data_filters**](EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) -[**search_entities_visualization_objects**](EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) -[**search_entities_workspace_data_filter_settings**](EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) -[**search_entities_workspace_data_filters**](EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) -[**search_entities_workspace_settings**](EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +[**search_entities_aggregated_facts**](EntitiesApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint +[**search_entities_analytical_dashboards**](EntitiesApi.md#search_entities_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search | The search endpoint +[**search_entities_attribute_hierarchies**](EntitiesApi.md#search_entities_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search | The search endpoint +[**search_entities_attributes**](EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint +[**search_entities_automation_results**](EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint +[**search_entities_automations**](EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint +[**search_entities_computed_attributes**](EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint +[**search_entities_custom_application_settings**](EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint +[**search_entities_dashboard_plugins**](EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint +[**search_entities_datasets**](EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint +[**search_entities_documents**](EntitiesApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint +[**search_entities_export_definitions**](EntitiesApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint +[**search_entities_facts**](EntitiesApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint +[**search_entities_filter_contexts**](EntitiesApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint +[**search_entities_filter_views**](EntitiesApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint +[**search_entities_knowledge_recommendations**](EntitiesApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint +[**search_entities_labels**](EntitiesApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint +[**search_entities_memory_items**](EntitiesApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint +[**search_entities_metrics**](EntitiesApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint +[**search_entities_parameters**](EntitiesApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint +[**search_entities_user_data_filters**](EntitiesApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint +[**search_entities_visualization_objects**](EntitiesApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint +[**search_entities_workspace_data_filter_settings**](EntitiesApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint +[**search_entities_workspace_data_filters**](EntitiesApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint +[**search_entities_workspace_settings**](EntitiesApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint [**update_entity**](EntitiesApi.md#update_entity) | **PUT** /api/v1/entities/llmEndpoints/{id} | PUT LLM endpoint entity (Removed) [**update_entity_agents**](EntitiesApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity [**update_entity_analytical_dashboards**](EntitiesApi.md#update_entity_analytical_dashboards) | **PUT** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId} | Put Dashboards @@ -19588,7 +19589,7 @@ No authorization required # **patch_entity_attributes** > JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) -Patch an Attribute (beta) +Patch an Attribute ### Example @@ -19653,7 +19654,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -19662,7 +19663,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch an Attribute (beta) + # Patch an Attribute api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -20902,7 +20903,7 @@ No authorization required # **patch_entity_datasets** > JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) -Patch a Dataset (beta) +Patch a Dataset ### Example @@ -20947,7 +20948,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -20956,7 +20957,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Dataset (beta) + # Patch a Dataset api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -21749,7 +21750,7 @@ No authorization required # **patch_entity_facts** > JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) -Patch a Fact (beta) +Patch a Fact ### Example @@ -21794,7 +21795,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -21803,7 +21804,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -22364,7 +22365,7 @@ No authorization required # **patch_entity_labels** > JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) -Patch a Label (beta) +Patch a Label ### Example @@ -22424,7 +22425,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -22433,7 +22434,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -24988,7 +24989,7 @@ No authorization required # **search_entities_aggregated_facts** > JsonApiAggregatedFactOutList search_entities_aggregated_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25036,7 +25037,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25045,7 +25046,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25087,7 +25088,7 @@ No authorization required # **search_entities_analytical_dashboards** > JsonApiAnalyticalDashboardOutList search_entities_analytical_dashboards(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25135,7 +25136,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25144,7 +25145,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_analytical_dashboards(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25186,7 +25187,7 @@ No authorization required # **search_entities_attribute_hierarchies** > JsonApiAttributeHierarchyOutList search_entities_attribute_hierarchies(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25234,7 +25235,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25243,7 +25244,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attribute_hierarchies(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25285,7 +25286,7 @@ No authorization required # **search_entities_attributes** > JsonApiAttributeOutList search_entities_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25333,7 +25334,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25342,7 +25343,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25384,7 +25385,7 @@ No authorization required # **search_entities_automation_results** > JsonApiAutomationResultOutList search_entities_automation_results(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25432,7 +25433,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25441,7 +25442,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automation_results(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25483,7 +25484,7 @@ No authorization required # **search_entities_automations** > JsonApiAutomationOutList search_entities_automations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25531,7 +25532,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25540,7 +25541,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_automations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25582,7 +25583,7 @@ No authorization required # **search_entities_computed_attributes** > JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25630,7 +25631,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25639,7 +25640,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25681,7 +25682,7 @@ No authorization required # **search_entities_custom_application_settings** > JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25729,7 +25730,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25738,7 +25739,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25780,7 +25781,7 @@ No authorization required # **search_entities_dashboard_plugins** > JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25828,7 +25829,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25837,7 +25838,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25879,7 +25880,7 @@ No authorization required # **search_entities_datasets** > JsonApiDatasetOutList search_entities_datasets(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -25927,7 +25928,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25936,7 +25937,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_datasets(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -25967,6 +25968,105 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[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) + +# **search_entities_documents** +> JsonApiPublisherDocumentOutList search_entities_documents(workspace_id, entity_search_body) + +The search endpoint + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->search_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->search_entities_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -25978,7 +26078,7 @@ No authorization required # **search_entities_export_definitions** > JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26026,7 +26126,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26035,7 +26135,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26077,7 +26177,7 @@ No authorization required # **search_entities_facts** > JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26125,7 +26225,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26134,7 +26234,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26176,7 +26276,7 @@ No authorization required # **search_entities_filter_contexts** > JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26224,7 +26324,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26233,7 +26333,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26275,7 +26375,7 @@ No authorization required # **search_entities_filter_views** > JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26323,7 +26423,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26332,7 +26432,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26374,7 +26474,7 @@ No authorization required # **search_entities_knowledge_recommendations** > JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26422,7 +26522,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26431,7 +26531,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26473,7 +26573,7 @@ No authorization required # **search_entities_labels** > JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26521,7 +26621,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26530,7 +26630,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26572,7 +26672,7 @@ No authorization required # **search_entities_memory_items** > JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26620,7 +26720,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26629,7 +26729,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26671,7 +26771,7 @@ No authorization required # **search_entities_metrics** > JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26719,7 +26819,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26728,7 +26828,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26770,7 +26870,7 @@ No authorization required # **search_entities_parameters** > JsonApiParameterOutList search_entities_parameters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26818,7 +26918,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26827,7 +26927,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26869,7 +26969,7 @@ No authorization required # **search_entities_user_data_filters** > JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -26917,7 +27017,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26926,7 +27026,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -26968,7 +27068,7 @@ No authorization required # **search_entities_visualization_objects** > JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -27016,7 +27116,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27025,7 +27125,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27067,7 +27167,7 @@ No authorization required # **search_entities_workspace_data_filter_settings** > JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -27115,7 +27215,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27124,7 +27224,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27166,7 +27266,7 @@ No authorization required # **search_entities_workspace_data_filters** > JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -27214,7 +27314,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27223,7 +27323,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27265,7 +27365,7 @@ No authorization required # **search_entities_workspace_settings** > JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -27313,7 +27413,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -27322,7 +27422,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ExportDefinitionControllerApi.md b/gooddata-api-client/docs/ExportDefinitionControllerApi.md index 37c2ebcf1..2cdb52ec5 100644 --- a/gooddata-api-client/docs/ExportDefinitionControllerApi.md +++ b/gooddata-api-client/docs/ExportDefinitionControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_export_definitions**](ExportDefinitionControllerApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions [**get_entity_export_definitions**](ExportDefinitionControllerApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition [**patch_entity_export_definitions**](ExportDefinitionControllerApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -[**search_entities_export_definitions**](ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +[**search_entities_export_definitions**](ExportDefinitionControllerApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint [**update_entity_export_definitions**](ExportDefinitionControllerApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition @@ -479,7 +479,7 @@ No authorization required # **search_entities_export_definitions** > JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -527,7 +527,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -536,7 +536,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ExportDefinitionsApi.md b/gooddata-api-client/docs/ExportDefinitionsApi.md index 43468e8dc..d954f95d7 100644 --- a/gooddata-api-client/docs/ExportDefinitionsApi.md +++ b/gooddata-api-client/docs/ExportDefinitionsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_export_definitions**](ExportDefinitionsApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions [**get_entity_export_definitions**](ExportDefinitionsApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition [**patch_entity_export_definitions**](ExportDefinitionsApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition -[**search_entities_export_definitions**](ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint (beta) +[**search_entities_export_definitions**](ExportDefinitionsApi.md#search_entities_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search | The search endpoint [**update_entity_export_definitions**](ExportDefinitionsApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition @@ -479,7 +479,7 @@ No authorization required # **search_entities_export_definitions** > JsonApiExportDefinitionOutList search_entities_export_definitions(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -527,7 +527,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -536,7 +536,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_export_definitions(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FactControllerApi.md b/gooddata-api-client/docs/FactControllerApi.md index 98e902785..2ba17bc29 100644 --- a/gooddata-api-client/docs/FactControllerApi.md +++ b/gooddata-api-client/docs/FactControllerApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_facts**](FactControllerApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts [**get_entity_facts**](FactControllerApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -[**patch_entity_facts**](FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -[**search_entities_facts**](FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +[**patch_entity_facts**](FactControllerApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact +[**search_entities_facts**](FactControllerApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint # **get_all_entities_facts** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_facts** > JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) -Patch a Fact (beta) +Patch a Fact ### Example @@ -242,7 +242,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -251,7 +251,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -294,7 +294,7 @@ No authorization required # **search_entities_facts** > JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -342,7 +342,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -351,7 +351,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FactsApi.md b/gooddata-api-client/docs/FactsApi.md index cbfd0414a..0f19425e5 100644 --- a/gooddata-api-client/docs/FactsApi.md +++ b/gooddata-api-client/docs/FactsApi.md @@ -8,9 +8,9 @@ Method | HTTP request | Description [**get_all_entities_facts**](FactsApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts [**get_entity_aggregated_facts**](FactsApi.md#get_entity_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId} | Get an Aggregated Fact [**get_entity_facts**](FactsApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact -[**patch_entity_facts**](FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) -[**search_entities_aggregated_facts**](FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint (beta) -[**search_entities_facts**](FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint (beta) +[**patch_entity_facts**](FactsApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact +[**search_entities_aggregated_facts**](FactsApi.md#search_entities_aggregated_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search | The search endpoint +[**search_entities_facts**](FactsApi.md#search_entities_facts) | **POST** /api/v1/entities/workspaces/{workspaceId}/facts/search | The search endpoint # **get_all_entities_aggregated_facts** @@ -384,7 +384,7 @@ No authorization required # **patch_entity_facts** > JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) -Patch a Fact (beta) +Patch a Fact ### Example @@ -429,7 +429,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -438,7 +438,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Fact (beta) + # Patch a Fact api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -481,7 +481,7 @@ No authorization required # **search_entities_aggregated_facts** > JsonApiAggregatedFactOutList search_entities_aggregated_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -529,7 +529,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -538,7 +538,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_aggregated_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -580,7 +580,7 @@ No authorization required # **search_entities_facts** > JsonApiFactOutList search_entities_facts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -628,7 +628,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -637,7 +637,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_facts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FailedOperation.md b/gooddata-api-client/docs/FailedOperation.md index bf6166a1f..eaf904207 100644 --- a/gooddata-api-client/docs/FailedOperation.md +++ b/gooddata-api-client/docs/FailedOperation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **error** | [**OperationError**](OperationError.md) | | **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. | **status** | **str** | | defaults to "failed" **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/FilterContextApi.md b/gooddata-api-client/docs/FilterContextApi.md index 48265b7b2..cf974e64e 100644 --- a/gooddata-api-client/docs/FilterContextApi.md +++ b/gooddata-api-client/docs/FilterContextApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_filter_contexts**](FilterContextApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context [**get_entity_filter_contexts**](FilterContextApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context [**patch_entity_filter_contexts**](FilterContextApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -[**search_entities_filter_contexts**](FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +[**search_entities_filter_contexts**](FilterContextApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint [**update_entity_filter_contexts**](FilterContextApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context @@ -463,7 +463,7 @@ No authorization required # **search_entities_filter_contexts** > JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FilterContextControllerApi.md b/gooddata-api-client/docs/FilterContextControllerApi.md index cd1400022..d95e7126f 100644 --- a/gooddata-api-client/docs/FilterContextControllerApi.md +++ b/gooddata-api-client/docs/FilterContextControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_filter_contexts**](FilterContextControllerApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context [**get_entity_filter_contexts**](FilterContextControllerApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context [**patch_entity_filter_contexts**](FilterContextControllerApi.md#patch_entity_filter_contexts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Patch a Filter Context -[**search_entities_filter_contexts**](FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint (beta) +[**search_entities_filter_contexts**](FilterContextControllerApi.md#search_entities_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts/search | The search endpoint [**update_entity_filter_contexts**](FilterContextControllerApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context @@ -463,7 +463,7 @@ No authorization required # **search_entities_filter_contexts** > JsonApiFilterContextOutList search_entities_filter_contexts(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_contexts(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FilterDefinition.md b/gooddata-api-client/docs/FilterDefinition.md index f7e937e93..0f0517950 100644 --- a/gooddata-api-client/docs/FilterDefinition.md +++ b/gooddata-api-client/docs/FilterDefinition.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **compound_measure_value_filter** | [**CompoundMeasureValueFilterCompoundMeasureValueFilter**](CompoundMeasureValueFilterCompoundMeasureValueFilter.md) | | [optional] **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) | | [optional] +**parameterized_date_filter** | [**ParameterizedDateFilterParameterizedDateFilter**](ParameterizedDateFilterParameterizedDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] **all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md index 0df25771a..69a262c9f 100644 --- a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md +++ b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] **absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) | | [optional] +**parameterized_date_filter** | [**ParameterizedDateFilterParameterizedDateFilter**](ParameterizedDateFilterParameterizedDateFilter.md) | | [optional] **relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] **all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] **negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/FilterViewControllerApi.md b/gooddata-api-client/docs/FilterViewControllerApi.md index b464f2519..8e8586596 100644 --- a/gooddata-api-client/docs/FilterViewControllerApi.md +++ b/gooddata-api-client/docs/FilterViewControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_filter_views**](FilterViewControllerApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views [**get_entity_filter_views**](FilterViewControllerApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view [**patch_entity_filter_views**](FilterViewControllerApi.md#patch_entity_filter_views) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Patch Filter view -[**search_entities_filter_views**](FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +[**search_entities_filter_views**](FilterViewControllerApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint [**update_entity_filter_views**](FilterViewControllerApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views @@ -473,7 +473,7 @@ No authorization required # **search_entities_filter_views** > JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -521,7 +521,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -530,7 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/FilterViewsApi.md b/gooddata-api-client/docs/FilterViewsApi.md index 16882e1cd..22afdf6e0 100644 --- a/gooddata-api-client/docs/FilterViewsApi.md +++ b/gooddata-api-client/docs/FilterViewsApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description [**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 -[**search_entities_filter_views**](FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint (beta) +[**search_entities_filter_views**](FilterViewsApi.md#search_entities_filter_views) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterViews/search | The search endpoint [**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 @@ -555,7 +555,7 @@ No authorization required # **search_entities_filter_views** > JsonApiFilterViewOutList search_entities_filter_views(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -603,7 +603,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -612,7 +612,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_filter_views(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/GetAiLakeOperation200Response.md b/gooddata-api-client/docs/GetAiLakeOperation200Response.md index d7b04535a..58ba686e9 100644 --- a/gooddata-api-client/docs/GetAiLakeOperation200Response.md +++ b/gooddata-api-client/docs/GetAiLakeOperation200Response.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **status** | **str** | | **result** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Operation-specific result payload, can be missing for operations like delete | [optional] **id** | **str** | Id of the operation | [optional] -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | [optional] +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. | [optional] **error** | [**OperationError**](OperationError.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/GoodDataAiProviderConfig.md b/gooddata-api-client/docs/GoodDataAiProviderConfig.md new file mode 100644 index 000000000..dbc5c9f30 --- /dev/null +++ b/gooddata-api-client/docs/GoodDataAiProviderConfig.md @@ -0,0 +1,13 @@ +# GoodDataAiProviderConfig + +Configuration for GoodData AI provider. Inference is served by GoodData; no credentials are needed. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Provider type. | defaults to "GOODDATA_AI" +**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/JsonApiLlmProviderInAttributesProviderConfig.md b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md index 8ffabfb63..7931ce058 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderInAttributesProviderConfig.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **base_url** | **str** | Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways. | [optional] if omitted the server will use the default value of "https://api.anthropic.com" **organization** | **str, none_type** | OpenAI organization ID. | [optional] **auth** | [**AnthropicProviderAuth**](AnthropicProviderAuth.md) | | [optional] -**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "ANTHROPIC" +**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "GOODDATA_AI" **endpoint** | **str** | Azure OpenAI endpoint URL. | [optional] **region** | **str** | AWS region for Bedrock. | [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/JsonApiParameterInAttributesDefinition.md b/gooddata-api-client/docs/JsonApiParameterInAttributesDefinition.md index 190602832..8a8a4c520 100644 --- a/gooddata-api-client/docs/JsonApiParameterInAttributesDefinition.md +++ b/gooddata-api-client/docs/JsonApiParameterInAttributesDefinition.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The parameter type. | defaults to "STRING" +**type** | **str** | The parameter type. | defaults to "DATE_RANGE" **constraints** | [**StringConstraints**](StringConstraints.md) | | [optional] -**default_value** | **str** | | [optional] +**default_value** | [**DateRangeParameterValue**](DateRangeParameterValue.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/KnowledgeRecommendationControllerApi.md b/gooddata-api-client/docs/KnowledgeRecommendationControllerApi.md index 6456fe4be..c2cbae49c 100644 --- a/gooddata-api-client/docs/KnowledgeRecommendationControllerApi.md +++ b/gooddata-api-client/docs/KnowledgeRecommendationControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations [**get_entity_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation [**patch_entity_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -[**search_entities_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +[**search_entities_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint [**update_entity_knowledge_recommendations**](KnowledgeRecommendationControllerApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation @@ -503,7 +503,7 @@ No authorization required # **search_entities_knowledge_recommendations** > JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -551,7 +551,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -560,7 +560,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/KnowledgeRecommendationsApi.md b/gooddata-api-client/docs/KnowledgeRecommendationsApi.md index 1b7419914..244d02c37 100644 --- a/gooddata-api-client/docs/KnowledgeRecommendationsApi.md +++ b/gooddata-api-client/docs/KnowledgeRecommendationsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_knowledge_recommendations**](KnowledgeRecommendationsApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations [**get_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation [**patch_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -[**search_entities_knowledge_recommendations**](KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +[**search_entities_knowledge_recommendations**](KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint [**update_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation @@ -503,7 +503,7 @@ No authorization required # **search_entities_knowledge_recommendations** > JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -551,7 +551,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -560,7 +560,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/LabelControllerApi.md b/gooddata-api-client/docs/LabelControllerApi.md index 584b87bcb..2a11044bd 100644 --- a/gooddata-api-client/docs/LabelControllerApi.md +++ b/gooddata-api-client/docs/LabelControllerApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_labels**](LabelControllerApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels [**get_entity_labels**](LabelControllerApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label -[**patch_entity_labels**](LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -[**search_entities_labels**](LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) +[**patch_entity_labels**](LabelControllerApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label +[**search_entities_labels**](LabelControllerApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint # **get_all_entities_labels** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_labels** > JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) -Patch a Label (beta) +Patch a Label ### Example @@ -257,7 +257,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -266,7 +266,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -309,7 +309,7 @@ No authorization required # **search_entities_labels** > JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -357,7 +357,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -366,7 +366,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/LabelsApi.md b/gooddata-api-client/docs/LabelsApi.md index 287f7bac2..42746c410 100644 --- a/gooddata-api-client/docs/LabelsApi.md +++ b/gooddata-api-client/docs/LabelsApi.md @@ -6,8 +6,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_all_entities_labels**](LabelsApi.md#get_all_entities_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels | Get all Labels [**get_entity_labels**](LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label -[**patch_entity_labels**](LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) -[**search_entities_labels**](LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) +[**patch_entity_labels**](LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label +[**search_entities_labels**](LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint # **get_all_entities_labels** @@ -197,7 +197,7 @@ No authorization required # **patch_entity_labels** > JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) -Patch a Label (beta) +Patch a Label ### Example @@ -257,7 +257,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -266,7 +266,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Patch a Label (beta) + # Patch a Label api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -309,7 +309,7 @@ No authorization required # **search_entities_labels** > JsonApiLabelOutList search_entities_labels(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -357,7 +357,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -366,7 +366,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_labels(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index c1a37fe47..bbcee9c3d 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -2560,8 +2560,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -2788,6 +2798,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -2876,8 +2894,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -2942,6 +2970,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -3664,8 +3700,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -3892,6 +3938,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -3980,8 +4034,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -4046,6 +4110,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -6532,8 +6604,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -6760,6 +6842,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -6848,8 +6938,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -6914,6 +7014,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -8579,8 +8687,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -8807,6 +8925,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -8895,8 +9021,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -8961,6 +9097,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", diff --git a/gooddata-api-client/docs/LocalizationApi.md b/gooddata-api-client/docs/LocalizationApi.md index 5cb66b9da..c724a4793 100644 --- a/gooddata-api-client/docs/LocalizationApi.md +++ b/gooddata-api-client/docs/LocalizationApi.md @@ -4,21 +4,172 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**organization_localization_statistics**](LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. -[**organization_localization_usage**](LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. -[**organization_localization_usage_users**](LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. -[**organization_localization_usage_workspaces**](LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. -[**workspace_localization_statistics**](LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. -[**workspace_localization_usage**](LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. -[**workspace_localization_usage_users**](LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. +[**organization_localization_issue_workspaces**](LocalizationApi.md#organization_localization_issue_workspaces) | **GET** /api/v1/actions/organization/localization/issues/workspaces | (BETA) Workspaces with a localization issue. +[**organization_localization_issues**](LocalizationApi.md#organization_localization_issues) | **GET** /api/v1/actions/organization/localization/issues | (BETA) Localization issues of the organization. +[**organization_localization_statistics**](LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | Languages with translations in the organization. +[**organization_localization_usage**](LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | Languages used in the organization. +[**organization_localization_usage_users**](LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | Users who set a language themselves. +[**organization_localization_usage_workspaces**](LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | Workspaces that use a language. +[**workspace_localization_issues**](LocalizationApi.md#workspace_localization_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/issues | (BETA) Localization issues of the workspace. +[**workspace_localization_statistics**](LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | Languages with translations in the workspace. +[**workspace_localization_usage**](LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | Languages used in the workspace. +[**workspace_localization_usage_child_workspaces**](LocalizationApi.md#workspace_localization_usage_child_workspaces) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces | (BETA) Workspaces below the workspace that use a language. +[**workspace_localization_usage_users**](LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | Workspace members who get a language. +# **organization_localization_issue_workspaces** +> LocalizationIssueWorkspaces organization_localization_issue_workspaces(type, locale) + +(BETA) Workspaces with a localization issue. + +(BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_issue_workspaces import LocalizationIssueWorkspaces +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 = localization_api.LocalizationApi(api_client) + type = "METADATA_MISSING_TRANSLATION" # str | The type of the issue. + locale = "de-DE" # str | The language of the issue. + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspaces with a localization issue. + api_response = api_instance.organization_localization_issue_workspaces(type, locale) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_issue_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspaces with a localization issue. + api_response = api_instance.organization_localization_issue_workspaces(type, locale, name=name, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_issue_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | **str**| The type of the issue. | + **locale** | **str**| The language of the issue. | + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationIssueWorkspaces**](LocalizationIssueWorkspaces.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **organization_localization_issues** +> LocalizationIssues organization_localization_issues() + +(BETA) Localization issues of the organization. + +(BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_issues import LocalizationIssues +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 = localization_api.LocalizationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Localization issues of the organization. + api_response = api_instance.organization_localization_issues() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_issues: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LocalizationIssues**](LocalizationIssues.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + # **organization_localization_statistics** > LocalizationStatistics organization_localization_statistics() -(BETA) Languages with translations in the organization. +Languages with translations in the organization. -(BETA) Lists the languages that have at least one translation, separately for each kind of translation. +Lists the languages that have at least one translation, separately for each kind of translation. ### Example @@ -43,7 +194,7 @@ with gooddata_api_client.ApiClient() as api_client: # example, this endpoint has no required or optional parameters try: - # (BETA) Languages with translations in the organization. + # Languages with translations in the organization. api_response = api_instance.organization_localization_statistics() pprint(api_response) except gooddata_api_client.ApiException as e: @@ -79,9 +230,9 @@ No authorization required # **organization_localization_usage** > LocalizationUsage organization_localization_usage() -(BETA) Languages used in the organization. +Languages used in the organization. -(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. +Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. ### Example @@ -106,7 +257,7 @@ with gooddata_api_client.ApiClient() as api_client: # example, this endpoint has no required or optional parameters try: - # (BETA) Languages used in the organization. + # Languages used in the organization. api_response = api_instance.organization_localization_usage() pprint(api_response) except gooddata_api_client.ApiException as e: @@ -142,9 +293,9 @@ No authorization required # **organization_localization_usage_users** > LocalizationUsageUsers organization_localization_usage_users() -(BETA) Users who set a language themselves. +Users who set a language themselves. -(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language. ### Example @@ -176,7 +327,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Users who set a language themselves. + # Users who set a language themselves. api_response = api_instance.organization_localization_usage_users(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -220,9 +371,9 @@ No authorization required # **organization_localization_usage_workspaces** > LocalizationUsageWorkspaces organization_localization_usage_workspaces() -(BETA) Workspaces that use a language. +Workspaces that use a language. -(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. ### Example @@ -254,7 +405,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Workspaces that use a language. + # Workspaces that use a language. api_response = api_instance.organization_localization_usage_workspaces(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -287,6 +438,73 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **workspace_localization_issues** +> LocalizationIssues workspace_localization_issues(workspace_id) + +(BETA) Localization issues of the workspace. + +(BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_issues import LocalizationIssues +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 = localization_api.LocalizationApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Localization issues of the workspace. + api_response = api_instance.workspace_localization_issues(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_issues: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**LocalizationIssues**](LocalizationIssues.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -298,9 +516,9 @@ No authorization required # **workspace_localization_statistics** > LocalizationStatistics workspace_localization_statistics(workspace_id) -(BETA) Languages with translations in the workspace. +Languages with translations in the workspace. -(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. +Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent. ### Example @@ -323,14 +541,24 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = localization_api.LocalizationApi(api_client) workspace_id = "workspaceId_example" # str | + include_coverage = True # bool | (BETA) Adds translation counts for the workspace and each parent, root first. (optional) # example passing only required values which don't have defaults set try: - # (BETA) Languages with translations in the workspace. + # Languages with translations in the workspace. api_response = api_instance.workspace_localization_statistics(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling LocalizationApi->workspace_localization_statistics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Languages with translations in the workspace. + api_response = api_instance.workspace_localization_statistics(workspace_id, include_coverage=include_coverage) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_statistics: %s\n" % e) ``` @@ -339,6 +567,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | + **include_coverage** | **bool**| (BETA) Adds translation counts for the workspace and each parent, root first. | [optional] ### Return type @@ -365,9 +594,9 @@ No authorization required # **workspace_localization_usage** > WorkspaceLocalizationUsage workspace_localization_usage(workspace_id) -(BETA) Languages used in the workspace. +Languages used in the workspace. -(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. +Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way. ### Example @@ -393,7 +622,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Languages used in the workspace. + # Languages used in the workspace. api_response = api_instance.workspace_localization_usage(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -421,6 +650,94 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[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) + +# **workspace_localization_usage_child_workspaces** +> LocalizationUsageWorkspaces workspace_localization_usage_child_workspaces(workspace_id) + +(BETA) Workspaces below the workspace that use a language. + +(BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces +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 = localization_api.LocalizationApi(api_client) + workspace_id = "workspaceId_example" # str | + value = "de-DE" # str | Language tag that the workspace gets. (optional) + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "PARENT" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspaces below the workspace that use a language. + api_response = api_instance.workspace_localization_usage_child_workspaces(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_usage_child_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspaces below the workspace that use a language. + api_response = api_instance.workspace_localization_usage_child_workspaces(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_usage_child_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **value** | **str**| Language tag that the workspace gets. | [optional] + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageWorkspaces**](LocalizationUsageWorkspaces.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -432,9 +749,9 @@ No authorization required # **workspace_localization_usage_users** > LocalizationUsageUsers workspace_localization_usage_users(workspace_id) -(BETA) Workspace members who get a language. +Workspace members who get a language. -(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language. +Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language. ### Example @@ -466,7 +783,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Workspace members who get a language. + # Workspace members who get a language. api_response = api_instance.workspace_localization_usage_users(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -475,7 +792,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # (BETA) Workspace members who get a language. + # Workspace members who get a language. api_response = api_instance.workspace_localization_usage_users(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/LocalizationIssue.md b/gooddata-api-client/docs/LocalizationIssue.md new file mode 100644 index 000000000..2d304ae6d --- /dev/null +++ b/gooddata-api-client/docs/LocalizationIssue.md @@ -0,0 +1,15 @@ +# LocalizationIssue + +One localization issue in one language. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | The problem language. | +**type** | **str** | The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added. | +**workspaces** | **int** | Organization issues only. The number of workspaces with this issue. | [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/LocalizationIssueWorkspace.md b/gooddata-api-client/docs/LocalizationIssueWorkspace.md new file mode 100644 index 000000000..67f39283c --- /dev/null +++ b/gooddata-api-client/docs/LocalizationIssueWorkspace.md @@ -0,0 +1,16 @@ +# LocalizationIssueWorkspace + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by_setting** | [**LocalizationResolvedValues**](LocalizationResolvedValues.md) | | +**children_count** | **int** | Number of direct child workspaces. | +**id** | **str** | | +**name** | **str** | | +**parent_id** | **str, none_type** | The parent workspace, or null for a root workspace. | [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/LocalizationIssueWorkspaces.md b/gooddata-api-client/docs/LocalizationIssueWorkspaces.md new file mode 100644 index 000000000..5377b01d9 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationIssueWorkspaces.md @@ -0,0 +1,13 @@ +# LocalizationIssueWorkspaces + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_count** | **int** | The total number of workspaces with this issue that match the name filter. | +**workspaces** | [**[LocalizationIssueWorkspace]**](LocalizationIssueWorkspace.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/LocalizationIssues.md b/gooddata-api-client/docs/LocalizationIssues.md new file mode 100644 index 000000000..a827a3c4c --- /dev/null +++ b/gooddata-api-client/docs/LocalizationIssues.md @@ -0,0 +1,12 @@ +# LocalizationIssues + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**issues** | [**[LocalizationIssue]**](LocalizationIssue.md) | Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong. | +**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/LocalizationMetadataStatistics.md b/gooddata-api-client/docs/LocalizationMetadataStatistics.md index aa8e0e3dd..4d20b3c29 100644 --- a/gooddata-api-client/docs/LocalizationMetadataStatistics.md +++ b/gooddata-api-client/docs/LocalizationMetadataStatistics.md @@ -6,6 +6,7 @@ Translations of titles, descriptions, tags and free-form texts of workspace obje Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **locales** | [**[LocalizationStatisticsLocale]**](LocalizationStatisticsLocale.md) | | +**workspaces** | [**[LocalizationStatisticsWorkspace]**](LocalizationStatisticsWorkspace.md) | (BETA) Translation counts of the workspace and each parent workspace that the user can see, root first. Present only with `includeCoverage=true` on the workspace endpoint. | [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/LocalizationSettingUsage.md b/gooddata-api-client/docs/LocalizationSettingUsage.md index 8238a1df5..12cc01bda 100644 --- a/gooddata-api-client/docs/LocalizationSettingUsage.md +++ b/gooddata-api-client/docs/LocalizationSettingUsage.md @@ -1,11 +1,13 @@ # LocalizationSettingUsage +(BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **users** | [**LocalizationCount**](LocalizationCount.md) | | **workspaces** | [**LocalizationCount**](LocalizationCount.md) | | +**child_workspaces** | [**LocalizationCount**](LocalizationCount.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/LocalizationStatisticsTranslatedLocale.md b/gooddata-api-client/docs/LocalizationStatisticsTranslatedLocale.md new file mode 100644 index 000000000..3bfc2b406 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationStatisticsTranslatedLocale.md @@ -0,0 +1,14 @@ +# LocalizationStatisticsTranslatedLocale + +Translated texts of one workspace in one language. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | Language tag. | +**translated** | **int** | Texts of the workspace with a translation. A title, description or tag edited after its translation still counts. | +**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/LocalizationStatisticsWorkspace.md b/gooddata-api-client/docs/LocalizationStatisticsWorkspace.md new file mode 100644 index 000000000..935d8c678 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationStatisticsWorkspace.md @@ -0,0 +1,17 @@ +# LocalizationStatisticsWorkspace + +Metadata texts of one workspace. A row counts only the texts that the workspace owns. A child workspace sums its row and the rows of its parents. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Workspace ID. | +**locales** | [**[LocalizationStatisticsTranslatedLocale]**](LocalizationStatisticsTranslatedLocale.md) | Every language of `metadata.locales`, sorted, with 0 where nothing is translated. | +**name** | **str** | Workspace name. | +**total** | **int** | Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted. | +**parent_id** | **str, none_type** | Parent workspace ID, null for a root workspace. | [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/LocalizationUsageValue.md b/gooddata-api-client/docs/LocalizationUsageValue.md index 6d7a8c3c6..a8a231d2c 100644 --- a/gooddata-api-client/docs/LocalizationUsageValue.md +++ b/gooddata-api-client/docs/LocalizationUsageValue.md @@ -1,6 +1,6 @@ # LocalizationUsageValue -One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting. +One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting. (BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it. ## Properties Name | Type | Description | Notes @@ -9,6 +9,7 @@ Name | Type | Description | Notes **content** | [**LocalizationContent**](LocalizationContent.md) | | **users** | [**LocalizationCount**](LocalizationCount.md) | | **workspaces** | [**LocalizationCount**](LocalizationCount.md) | | +**child_workspaces** | [**LocalizationCount**](LocalizationCount.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/MemoryItemControllerApi.md b/gooddata-api-client/docs/MemoryItemControllerApi.md index aa6ef08c9..4bef2db61 100644 --- a/gooddata-api-client/docs/MemoryItemControllerApi.md +++ b/gooddata-api-client/docs/MemoryItemControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_memory_items**](MemoryItemControllerApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items [**get_entity_memory_items**](MemoryItemControllerApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item [**patch_entity_memory_items**](MemoryItemControllerApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item -[**search_entities_memory_items**](MemoryItemControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +[**search_entities_memory_items**](MemoryItemControllerApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint [**update_entity_memory_items**](MemoryItemControllerApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item @@ -473,7 +473,7 @@ No authorization required # **search_entities_memory_items** > JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -521,7 +521,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -530,7 +530,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/MemoryItemsApi.md b/gooddata-api-client/docs/MemoryItemsApi.md index 838a28931..252068f7f 100644 --- a/gooddata-api-client/docs/MemoryItemsApi.md +++ b/gooddata-api-client/docs/MemoryItemsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description [**get_entity_org_memory_items**](MemoryItemsApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity [**patch_entity_memory_items**](MemoryItemsApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item [**patch_entity_org_memory_items**](MemoryItemsApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity -[**search_entities_memory_items**](MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +[**search_entities_memory_items**](MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint [**update_entity_memory_items**](MemoryItemsApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item [**update_entity_org_memory_items**](MemoryItemsApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity @@ -898,7 +898,7 @@ No authorization required # **search_entities_memory_items** > JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -946,7 +946,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -955,7 +955,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/MetricControllerApi.md b/gooddata-api-client/docs/MetricControllerApi.md index 6af607027..62c6ec1cb 100644 --- a/gooddata-api-client/docs/MetricControllerApi.md +++ b/gooddata-api-client/docs/MetricControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_metrics**](MetricControllerApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics [**get_entity_metrics**](MetricControllerApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric [**patch_entity_metrics**](MetricControllerApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -[**search_entities_metrics**](MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +[**search_entities_metrics**](MetricControllerApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint [**update_entity_metrics**](MetricControllerApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric @@ -505,7 +505,7 @@ No authorization required # **search_entities_metrics** > JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -553,7 +553,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -562,7 +562,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/MetricsApi.md b/gooddata-api-client/docs/MetricsApi.md index 74bcf29ee..eef483083 100644 --- a/gooddata-api-client/docs/MetricsApi.md +++ b/gooddata-api-client/docs/MetricsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_metrics**](MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics [**get_entity_metrics**](MetricsApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric [**patch_entity_metrics**](MetricsApi.md#patch_entity_metrics) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Patch a Metric -[**search_entities_metrics**](MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint (beta) +[**search_entities_metrics**](MetricsApi.md#search_entities_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics/search | The search endpoint [**update_entity_metrics**](MetricsApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric @@ -505,7 +505,7 @@ No authorization required # **search_entities_metrics** > JsonApiMetricOutList search_entities_metrics(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -553,7 +553,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -562,7 +562,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_metrics(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/Operation.md b/gooddata-api-client/docs/Operation.md index 2e33f9f83..38d234902 100644 --- a/gooddata-api-client/docs/Operation.md +++ b/gooddata-api-client/docs/Operation.md @@ -6,7 +6,7 @@ Represents a Long-Running Operation: a process that takes some time to complete. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. | **status** | **str** | | **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/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 5259ee682..87ecc02c5 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -1513,8 +1513,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -1741,6 +1751,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -1829,8 +1847,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -1895,6 +1923,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", diff --git a/gooddata-api-client/docs/ParameterControllerApi.md b/gooddata-api-client/docs/ParameterControllerApi.md index 0ae50c9b6..f8c0c74a1 100644 --- a/gooddata-api-client/docs/ParameterControllerApi.md +++ b/gooddata-api-client/docs/ParameterControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_parameters**](ParameterControllerApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters [**get_entity_parameters**](ParameterControllerApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter [**patch_entity_parameters**](ParameterControllerApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter -[**search_entities_parameters**](ParameterControllerApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) +[**search_entities_parameters**](ParameterControllerApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint [**update_entity_parameters**](ParameterControllerApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter @@ -463,7 +463,7 @@ No authorization required # **search_entities_parameters** > JsonApiParameterOutList search_entities_parameters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ParameterDefinition.md b/gooddata-api-client/docs/ParameterDefinition.md index 1b97dc099..34a25a166 100644 --- a/gooddata-api-client/docs/ParameterDefinition.md +++ b/gooddata-api-client/docs/ParameterDefinition.md @@ -5,9 +5,9 @@ Parameter content (type-discriminated). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The parameter type. | defaults to "STRING" +**type** | **str** | The parameter type. | defaults to "DATE_RANGE" **constraints** | [**StringConstraints**](StringConstraints.md) | | [optional] -**default_value** | **str** | | [optional] +**default_value** | [**DateRangeParameterValue**](DateRangeParameterValue.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/ParameterizedDateFilter.md b/gooddata-api-client/docs/ParameterizedDateFilter.md new file mode 100644 index 000000000..b1cdc96b8 --- /dev/null +++ b/gooddata-api-client/docs/ParameterizedDateFilter.md @@ -0,0 +1,13 @@ +# ParameterizedDateFilter + +A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parameterized_date_filter** | [**ParameterizedDateFilterParameterizedDateFilter**](ParameterizedDateFilterParameterizedDateFilter.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/ParameterizedDateFilterParameterizedDateFilter.md b/gooddata-api-client/docs/ParameterizedDateFilterParameterizedDateFilter.md new file mode 100644 index 000000000..1b4777627 --- /dev/null +++ b/gooddata-api-client/docs/ParameterizedDateFilterParameterizedDateFilter.md @@ -0,0 +1,16 @@ +# ParameterizedDateFilterParameterizedDateFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**parameter** | [**AfmObjectIdentifierParameter**](AfmObjectIdentifierParameter.md) | | +**apply_on_result** | **bool** | | [optional] +**empty_value_handling** | **str** | Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates. | [optional] if omitted the server will use the default value of "EXCLUDE" +**local_identifier** | **str** | | [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/ParametersApi.md b/gooddata-api-client/docs/ParametersApi.md index 9aa29f5e3..bc5884b79 100644 --- a/gooddata-api-client/docs/ParametersApi.md +++ b/gooddata-api-client/docs/ParametersApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_parameters**](ParametersApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters [**get_entity_parameters**](ParametersApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter [**patch_entity_parameters**](ParametersApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter -[**search_entities_parameters**](ParametersApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) +[**search_entities_parameters**](ParametersApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint [**update_entity_parameters**](ParametersApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter @@ -463,7 +463,7 @@ No authorization required # **search_entities_parameters** > JsonApiParameterOutList search_entities_parameters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_parameters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/PendingOperation.md b/gooddata-api-client/docs/PendingOperation.md index 3c048f44d..7bc5bd7b8 100644 --- a/gooddata-api-client/docs/PendingOperation.md +++ b/gooddata-api-client/docs/PendingOperation.md @@ -6,7 +6,7 @@ Operation that is still pending Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. | **status** | **str** | | defaults to "pending" **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/PermissionsApi.md b/gooddata-api-client/docs/PermissionsApi.md index b1ba04595..a5bd26b80 100644 --- a/gooddata-api-client/docs/PermissionsApi.md +++ b/gooddata-api-client/docs/PermissionsApi.md @@ -6,7 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**attribute_permissions**](PermissionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions [**available_assignees**](PermissionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees -[**computed_attribute_permissions**](PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions +[**computed_attribute_permissions**](PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | Get Computed Attribute Permissions [**dashboard_permissions**](PermissionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions [**fact_permissions**](PermissionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions [**get_organization_permissions**](PermissionsApi.md#get_organization_permissions) | **GET** /api/v1/layout/organization/permissions | Get organization permissions @@ -15,21 +15,21 @@ Method | HTTP request | Description [**get_workspace_permissions**](PermissionsApi.md#get_workspace_permissions) | **GET** /api/v1/layout/workspaces/{workspaceId}/permissions | Get permissions for the workspace [**label_permissions**](PermissionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions [**manage_attribute_permissions**](PermissionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute -[**manage_computed_attribute_permissions**](PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute +[**manage_computed_attribute_permissions**](PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | Manage Permissions for a Computed Attribute [**manage_dashboard_permissions**](PermissionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard [**manage_data_source_permissions**](PermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source [**manage_fact_permissions**](PermissionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact [**manage_label_permissions**](PermissionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label -[**manage_metric_permissions**](PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric +[**manage_metric_permissions**](PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | Manage Permissions for a Metric [**manage_organization_permissions**](PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization -[**manage_visualization_permissions**](PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization +[**manage_visualization_permissions**](PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | Manage Permissions for a Visualization [**manage_workspace_permissions**](PermissionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace -[**metric_permissions**](PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions +[**metric_permissions**](PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | Get Metric Permissions [**set_organization_permissions**](PermissionsApi.md#set_organization_permissions) | **PUT** /api/v1/layout/organization/permissions | Set organization permissions [**set_user_group_permissions**](PermissionsApi.md#set_user_group_permissions) | **PUT** /api/v1/layout/userGroups/{userGroupId}/permissions | Set permissions for the user-group [**set_user_permissions**](PermissionsApi.md#set_user_permissions) | **PUT** /api/v1/layout/users/{userId}/permissions | Set permissions for the user [**set_workspace_permissions**](PermissionsApi.md#set_workspace_permissions) | **PUT** /api/v1/layout/workspaces/{workspaceId}/permissions | Set permissions for the workspace -[**visualization_permissions**](PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions +[**visualization_permissions**](PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | Get Visualization Permissions # **attribute_permissions** @@ -169,7 +169,7 @@ No authorization required # **computed_attribute_permissions** > ComputedAttributePermissions computed_attribute_permissions(workspace_id, computed_attribute_id) -(BETA) Get Computed Attribute Permissions +Get Computed Attribute Permissions ### Example @@ -196,7 +196,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Computed Attribute Permissions + # Get Computed Attribute Permissions api_response = api_instance.computed_attribute_permissions(workspace_id, computed_attribute_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -771,7 +771,7 @@ No authorization required # **manage_computed_attribute_permissions** > manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) -(BETA) Manage Permissions for a Computed Attribute +Manage Permissions for a Computed Attribute ### Example @@ -801,7 +801,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Computed Attribute + # Manage Permissions for a Computed Attribute api_instance.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling PermissionsApi->manage_computed_attribute_permissions: %s\n" % e) @@ -1129,7 +1129,7 @@ No authorization required # **manage_metric_permissions** > manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) -(BETA) Manage Permissions for a Metric +Manage Permissions for a Metric ### Example @@ -1159,7 +1159,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Metric + # Manage Permissions for a Metric api_instance.manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling PermissionsApi->manage_metric_permissions: %s\n" % e) @@ -1275,7 +1275,7 @@ No authorization required # **manage_visualization_permissions** > manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) -(BETA) Manage Permissions for a Visualization +Manage Permissions for a Visualization ### Example @@ -1305,7 +1305,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Manage Permissions for a Visualization + # Manage Permissions for a Visualization api_instance.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) except gooddata_api_client.ApiException as e: print("Exception when calling PermissionsApi->manage_visualization_permissions: %s\n" % e) @@ -1426,7 +1426,7 @@ No authorization required # **metric_permissions** > MetricPermissions metric_permissions(workspace_id, metric_id) -(BETA) Get Metric Permissions +Get Metric Permissions ### Example @@ -1453,7 +1453,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Metric Permissions + # Get Metric Permissions api_response = api_instance.metric_permissions(workspace_id, metric_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1810,7 +1810,7 @@ No authorization required # **visualization_permissions** > VisualizationPermissions visualization_permissions(workspace_id, visualization_object_id) -(BETA) Get Visualization Permissions +Get Visualization Permissions ### Example @@ -1837,7 +1837,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Get Visualization Permissions + # Get Visualization Permissions api_response = api_instance.visualization_permissions(workspace_id, visualization_object_id) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/PluginsApi.md b/gooddata-api-client/docs/PluginsApi.md index 1350b28a2..be82906bc 100644 --- a/gooddata-api-client/docs/PluginsApi.md +++ b/gooddata-api-client/docs/PluginsApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_dashboard_plugins**](PluginsApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins [**get_entity_dashboard_plugins**](PluginsApi.md#get_entity_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Get a Plugin [**patch_entity_dashboard_plugins**](PluginsApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin -[**search_entities_dashboard_plugins**](PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) +[**search_entities_dashboard_plugins**](PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint [**update_entity_dashboard_plugins**](PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin @@ -463,7 +463,7 @@ No authorization required # **search_entities_dashboard_plugins** > JsonApiDashboardPluginOutList search_entities_dashboard_plugins(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -511,7 +511,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -520,7 +520,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_dashboard_plugins(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md b/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md index b20b4ca65..de509994f 100644 --- a/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md +++ b/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **style** | [**PublisherDocumentTextStyle**](PublisherDocumentTextStyle.md) | | [optional] **text** | **str** | Overrides the default title; may contain text variables. | [optional] -**visible** | **bool** | Default `true`. | [optional] +**visible** | **bool** | When left out, a visualization's title is hidden and a takeaway's is shown. | [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/PublisherDocumentsApi.md b/gooddata-api-client/docs/PublisherDocumentsApi.md index 778a97541..f639b72d4 100644 --- a/gooddata-api-client/docs/PublisherDocumentsApi.md +++ b/gooddata-api-client/docs/PublisherDocumentsApi.md @@ -19,6 +19,7 @@ Method | HTTP request | Description [**patch_entity_document_templates**](PublisherDocumentsApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template [**patch_entity_documents**](PublisherDocumentsApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document [**patch_entity_page_templates**](PublisherDocumentsApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +[**search_entities_documents**](PublisherDocumentsApi.md#search_entities_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents/search | The search endpoint [**update_entity_document_templates**](PublisherDocumentsApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template [**update_entity_documents**](PublisherDocumentsApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document [**update_entity_page_templates**](PublisherDocumentsApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template @@ -2021,6 +2022,105 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[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) + +# **search_entities_documents** +> JsonApiPublisherDocumentOutList search_entities_documents(workspace_id, entity_search_body) + +The search endpoint + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +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 = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->search_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint + api_response = api_instance.search_entities_documents(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->search_entities_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index 46f1fe049..5daa3b779 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -4,16 +4,16 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_raw_export**](RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request -[**get_raw_export**](RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**create_raw_export**](RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | Create raw export request +[**get_raw_export**](RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | Retrieve exported files # **create_raw_export** > ExportResponse create_raw_export(workspace_id, raw_export_request) -(EXPERIMENTAL) Create raw export request +Create raw export request -Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. +A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. ### Example @@ -109,7 +109,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Create raw export request + # Create raw export request api_response = api_instance.create_raw_export(workspace_id, raw_export_request) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -149,9 +149,9 @@ No authorization required # **get_raw_export** > file_type get_raw_export(workspace_id, export_id) -(EXPERIMENTAL) Retrieve exported files +Retrieve exported files -Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. +After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -177,7 +177,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Retrieve exported files + # Retrieve exported files api_response = api_instance.get_raw_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/RelativeBoundedDateFilter.md b/gooddata-api-client/docs/RelativeBoundedDateFilter.md index 10dc6d766..af98f06ec 100644 --- a/gooddata-api-client/docs/RelativeBoundedDateFilter.md +++ b/gooddata-api-client/docs/RelativeBoundedDateFilter.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **granularity** | **str** | | -**_from** | **int** | | [optional] -**to** | **int** | | [optional] +**_from** | **int, none_type** | | [optional] +**to** | **int, none_type** | | [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/ReportingSettingsApi.md b/gooddata-api-client/docs/ReportingSettingsApi.md index 74110a70b..6a9d0fc41 100644 --- a/gooddata-api-client/docs/ReportingSettingsApi.md +++ b/gooddata-api-client/docs/ReportingSettingsApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**resolve_all_settings_without_workspace**](ReportingSettingsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. [**resolve_settings_without_workspace**](ReportingSettingsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace. +[**validate_embedding_origin**](ReportingSettingsApi.md#validate_embedding_origin) | **POST** /api/v1/actions/validateEmbeddingOrigin | Validate an embedding origin. # **resolve_all_settings_without_workspace** @@ -157,3 +158,73 @@ 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) +# **validate_embedding_origin** +> ValidateEmbeddingOriginResponse validate_embedding_origin(validate_embedding_origin_request) + +Validate an embedding origin. + +Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import reporting_settings_api +from gooddata_api_client.model.validate_embedding_origin_request import ValidateEmbeddingOriginRequest +from gooddata_api_client.model.validate_embedding_origin_response import ValidateEmbeddingOriginResponse +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 = reporting_settings_api.ReportingSettingsApi(api_client) + validate_embedding_origin_request = ValidateEmbeddingOriginRequest( + origin="https://app.example.com", + ) # ValidateEmbeddingOriginRequest | + + # example passing only required values which don't have defaults set + try: + # Validate an embedding origin. + api_response = api_instance.validate_embedding_origin(validate_embedding_origin_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportingSettingsApi->validate_embedding_origin: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **validate_embedding_origin_request** | [**ValidateEmbeddingOriginRequest**](ValidateEmbeddingOriginRequest.md)| | + +### Return type + +[**ValidateEmbeddingOriginResponse**](ValidateEmbeddingOriginResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Whether the origin may embed the application. | - | + +[[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) + diff --git a/gooddata-api-client/docs/ResultCacheMetadata.md b/gooddata-api-client/docs/ResultCacheMetadata.md index ca7506f26..5d271ef97 100644 --- a/gooddata-api-client/docs/ResultCacheMetadata.md +++ b/gooddata-api-client/docs/ResultCacheMetadata.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **execution_response** | [**ExecutionResponse**](ExecutionResponse.md) | | **result_size** | **int** | | **result_spec** | [**ResultSpec**](ResultSpec.md) | | +**computation_profile** | [**ComputationProfile**](ComputationProfile.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/SucceededOperation.md b/gooddata-api-client/docs/SucceededOperation.md index 18cbcfa68..25ab8e022 100644 --- a/gooddata-api-client/docs/SucceededOperation.md +++ b/gooddata-api-client/docs/SucceededOperation.md @@ -6,7 +6,7 @@ Operation that has succeeded Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. | **status** | **str** | | defaults to "succeeded" **result** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Operation-specific result payload, can be missing for operations like delete | [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/UserDataFilterControllerApi.md b/gooddata-api-client/docs/UserDataFilterControllerApi.md index 16d0be454..3599bf97a 100644 --- a/gooddata-api-client/docs/UserDataFilterControllerApi.md +++ b/gooddata-api-client/docs/UserDataFilterControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_user_data_filters**](UserDataFilterControllerApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters [**get_entity_user_data_filters**](UserDataFilterControllerApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter [**patch_entity_user_data_filters**](UserDataFilterControllerApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter -[**search_entities_user_data_filters**](UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint (beta) +[**search_entities_user_data_filters**](UserDataFilterControllerApi.md#search_entities_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/search | The search endpoint [**update_entity_user_data_filters**](UserDataFilterControllerApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter @@ -479,7 +479,7 @@ No authorization required # **search_entities_user_data_filters** > JsonApiUserDataFilterOutList search_entities_user_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -527,7 +527,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -536,7 +536,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_user_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/ValidateEmbeddingOriginRequest.md b/gooddata-api-client/docs/ValidateEmbeddingOriginRequest.md new file mode 100644 index 000000000..bf76ae8ab --- /dev/null +++ b/gooddata-api-client/docs/ValidateEmbeddingOriginRequest.md @@ -0,0 +1,13 @@ +# ValidateEmbeddingOriginRequest + +An origin to check against the embedding origins of the organization. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origin** | **str** | The origin of the embedding application, or `*` when it hides its origin. | +**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/ValidateEmbeddingOriginResponse.md b/gooddata-api-client/docs/ValidateEmbeddingOriginResponse.md new file mode 100644 index 000000000..b307cc686 --- /dev/null +++ b/gooddata-api-client/docs/ValidateEmbeddingOriginResponse.md @@ -0,0 +1,13 @@ +# ValidateEmbeddingOriginResponse + +Whether the origin may embed the application. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**valid** | **bool** | True when the embedding origins of the organization allow the origin. | +**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/VisualizationObjectApi.md b/gooddata-api-client/docs/VisualizationObjectApi.md index 0249269b2..10802e96e 100644 --- a/gooddata-api-client/docs/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/VisualizationObjectApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_visualization_objects**](VisualizationObjectApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects [**get_entity_visualization_objects**](VisualizationObjectApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object [**patch_entity_visualization_objects**](VisualizationObjectApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -[**search_entities_visualization_objects**](VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +[**search_entities_visualization_objects**](VisualizationObjectApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint [**update_entity_visualization_objects**](VisualizationObjectApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object @@ -507,7 +507,7 @@ No authorization required # **search_entities_visualization_objects** > JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -555,7 +555,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -564,7 +564,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/VisualizationObjectControllerApi.md b/gooddata-api-client/docs/VisualizationObjectControllerApi.md index a40ccc774..dc8e11683 100644 --- a/gooddata-api-client/docs/VisualizationObjectControllerApi.md +++ b/gooddata-api-client/docs/VisualizationObjectControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_visualization_objects**](VisualizationObjectControllerApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects [**get_entity_visualization_objects**](VisualizationObjectControllerApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object [**patch_entity_visualization_objects**](VisualizationObjectControllerApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object -[**search_entities_visualization_objects**](VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint (beta) +[**search_entities_visualization_objects**](VisualizationObjectControllerApi.md#search_entities_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search | The search endpoint [**update_entity_visualization_objects**](VisualizationObjectControllerApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object @@ -507,7 +507,7 @@ No authorization required # **search_entities_visualization_objects** > JsonApiVisualizationObjectOutList search_entities_visualization_objects(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -555,7 +555,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -564,7 +564,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_visualization_objects(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md b/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md index da155d4f7..8c6957c0b 100644 --- a/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceDataFilterControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters [**get_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter [**patch_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter -[**search_entities_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint (beta) +[**search_entities_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#search_entities_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search | The search endpoint [**update_entity_workspace_data_filters**](WorkspaceDataFilterControllerApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter @@ -475,7 +475,7 @@ No authorization required # **search_entities_workspace_data_filters** > JsonApiWorkspaceDataFilterOutList search_entities_workspace_data_filters(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -523,7 +523,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -532,7 +532,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filters(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md b/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md index ac85b4d23..6676fdd1a 100644 --- a/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceDataFilterSettingControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters [**get_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter [**patch_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter -[**search_entities_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint (beta) +[**search_entities_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#search_entities_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search | The search endpoint [**update_entity_workspace_data_filter_settings**](WorkspaceDataFilterSettingControllerApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter @@ -469,7 +469,7 @@ No authorization required # **search_entities_workspace_data_filter_settings** > JsonApiWorkspaceDataFilterSettingOutList search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -517,7 +517,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -526,7 +526,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/WorkspaceSettingControllerApi.md b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md index 4334a415a..2d01dbd50 100644 --- a/gooddata-api-client/docs/WorkspaceSettingControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description [**get_all_entities_workspace_settings**](WorkspaceSettingControllerApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces [**get_entity_workspace_settings**](WorkspaceSettingControllerApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace [**patch_entity_workspace_settings**](WorkspaceSettingControllerApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -[**search_entities_workspace_settings**](WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +[**search_entities_workspace_settings**](WorkspaceSettingControllerApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint [**update_entity_workspace_settings**](WorkspaceSettingControllerApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace @@ -437,7 +437,7 @@ No authorization required # **search_entities_workspace_settings** > JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -485,7 +485,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -494,7 +494,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index b1b79b0fc..8aa4f9b72 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -449,8 +449,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -677,6 +687,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -765,8 +783,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -831,6 +859,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -1954,8 +1990,18 @@ with gooddata_api_client.ApiClient() as api_client: gap=PublisherDocumentAreaStyleGap(None), ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-review", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -2182,6 +2228,14 @@ with gooddata_api_client.ApiClient() as api_client: title="Sales Context", ), ], + metric_extensions=[ + DeclarativeMetricExtension( + id="total-sales", + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], + ), + ], metrics=[ DeclarativeMetric( certification="CERTIFIED", @@ -2270,8 +2324,18 @@ with gooddata_api_client.ApiClient() as api_client: vertical_align="top", ), ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), description="description_example", id="brand-cover", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), tags=[ "["brand"]", ], @@ -2336,6 +2400,14 @@ with gooddata_api_client.ApiClient() as api_client: }, ), ], + visualization_object_extensions=[ + DeclarativeVisualizationObjectExtension( + id="revenue-by-region", + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", diff --git a/gooddata-api-client/docs/WorkspacesSettingsApi.md b/gooddata-api-client/docs/WorkspacesSettingsApi.md index 4044f6971..37a4f0673 100644 --- a/gooddata-api-client/docs/WorkspacesSettingsApi.md +++ b/gooddata-api-client/docs/WorkspacesSettingsApi.md @@ -14,8 +14,8 @@ Method | HTTP request | Description [**get_entity_workspace_settings**](WorkspacesSettingsApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace [**patch_entity_custom_application_settings**](WorkspacesSettingsApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting [**patch_entity_workspace_settings**](WorkspacesSettingsApi.md#patch_entity_workspace_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Patch a Setting for Workspace -[**search_entities_custom_application_settings**](WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) -[**search_entities_workspace_settings**](WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint (beta) +[**search_entities_custom_application_settings**](WorkspacesSettingsApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint +[**search_entities_workspace_settings**](WorkspacesSettingsApi.md#search_entities_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search | The search endpoint [**update_entity_custom_application_settings**](WorkspacesSettingsApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting [**update_entity_workspace_settings**](WorkspacesSettingsApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace [**workspace_resolve_all_settings**](WorkspacesSettingsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. @@ -867,7 +867,7 @@ No authorization required # **search_entities_custom_application_settings** > JsonApiCustomApplicationSettingOutList search_entities_custom_application_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -915,7 +915,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -924,7 +924,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_custom_application_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -966,7 +966,7 @@ No authorization required # **search_entities_workspace_settings** > JsonApiWorkspaceSettingOutList search_entities_workspace_settings(workspace_id, entity_search_body) -The search endpoint (beta) +The search endpoint ### Example @@ -1014,7 +1014,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1023,7 +1023,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # The search endpoint (beta) + # The search endpoint api_response = api_instance.search_entities_workspace_settings(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/gooddata_api_client/api/actions_api.py b/gooddata-api-client/gooddata_api_client/api/actions_api.py index 567e16f45..d91aed92c 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -98,6 +98,8 @@ from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.model.localization_issue_workspaces import LocalizationIssueWorkspaces +from gooddata_api_client.model.localization_issues import LocalizationIssues from gooddata_api_client.model.localization_statistics import LocalizationStatistics from gooddata_api_client.model.localization_usage import LocalizationUsage from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers @@ -150,6 +152,8 @@ from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse from gooddata_api_client.model.upload_file_response import UploadFileResponse from gooddata_api_client.model.upload_geo_collection_file_response import UploadGeoCollectionFileResponse +from gooddata_api_client.model.validate_embedding_origin_request import ValidateEmbeddingOriginRequest +from gooddata_api_client.model.validate_embedding_origin_response import ValidateEmbeddingOriginResponse from gooddata_api_client.model.visual_export_request import VisualExportRequest from gooddata_api_client.model.visualization_object_execution import VisualizationObjectExecution from gooddata_api_client.model.visualization_permissions import VisualizationPermissions @@ -5892,6 +5896,125 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.organization_localization_issue_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssueWorkspaces,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/issues/workspaces', + 'operation_id': 'organization_localization_issue_workspaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'locale', + 'name', + 'page', + 'size', + ], + 'required': [ + 'type', + 'locale', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "MISSING_TRANSLATION": "METADATA_MISSING_TRANSLATION", + "LANGUAGE_MISMATCH": "METADATA_LANGUAGE_MISMATCH", + "UNUSED_TRANSLATION": "METADATA_UNUSED_TRANSLATION" + }, + }, + 'openapi_types': { + 'type': + (str,), + 'locale': + (str,), + 'name': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'type': 'type', + 'locale': 'locale', + 'name': 'name', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'type': 'query', + 'locale': 'query', + 'name': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_issues_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssues,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/issues', + 'operation_id': 'organization_localization_issues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.organization_localization_statistics_endpoint = _Endpoint( settings={ 'response_type': (LocalizationStatistics,), @@ -7874,6 +7997,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.stream_execution_progress_endpoint = _Endpoint( + settings={ + 'response_type': ([dict],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId}', + 'operation_id': 'stream_execution_progress', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'execution_id', + ], + 'required': [ + 'workspace_id', + 'execution_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'execution_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'execution_id': 'executionId', + }, + 'location_map': { + 'workspace_id': 'path', + 'execution_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/event-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) self.switch_active_identity_provider_endpoint = _Endpoint( settings={ 'response_type': None, @@ -8897,6 +9082,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.validate_embedding_origin_endpoint = _Endpoint( + settings={ + 'response_type': (ValidateEmbeddingOriginResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/validateEmbeddingOrigin', + 'operation_id': 'validate_embedding_origin', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'validate_embedding_origin_request', + ], + 'required': [ + 'validate_embedding_origin_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'validate_embedding_origin_request': + (ValidateEmbeddingOriginRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'validate_embedding_origin_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.validate_llm_endpoint_endpoint = _Endpoint( settings={ 'response_type': None, @@ -9039,6 +9274,55 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.workspace_localization_issues_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssues,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/issues', + 'operation_id': 'workspace_localization_issues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.workspace_localization_statistics_endpoint = _Endpoint( settings={ 'response_type': (LocalizationStatistics,), @@ -9051,6 +9335,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', + 'include_coverage', ], 'required': [ 'workspace_id', @@ -9070,12 +9355,16 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), + 'include_coverage': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'include_coverage': 'includeCoverage', }, 'location_map': { 'workspace_id': 'path', + 'include_coverage': 'query', }, 'collection_format_map': { } @@ -9137,12 +9426,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.workspace_localization_usage_users_endpoint = _Endpoint( + self.workspace_localization_usage_child_workspaces_endpoint = _Endpoint( settings={ - 'response_type': (LocalizationUsageUsers,), + 'response_type': (LocalizationUsageWorkspaces,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/users', - 'operation_id': 'workspace_localization_usage_users', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces', + 'operation_id': 'workspace_localization_usage_child_workspaces', 'http_method': 'GET', 'servers': None, }, @@ -9233,19 +9522,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.workspace_resolve_all_settings_endpoint = _Endpoint( + self.workspace_localization_usage_users_endpoint = _Endpoint( settings={ - 'response_type': ([ResolvedSetting],), + 'response_type': (LocalizationUsageUsers,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_all_settings', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/users', + 'operation_id': 'workspace_localization_usage_users', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'exclude_user_settings', + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', ], 'required': [ 'workspace_id', @@ -9253,7 +9547,98 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - ], + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'workspace_id': 'path', + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_resolve_all_settings_endpoint = _Endpoint( + settings={ + 'response_type': ([ResolvedSetting],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + 'operation_id': 'workspace_resolve_all_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'exclude_user_settings', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], 'validation': [ ] }, @@ -11680,7 +12065,7 @@ def computed_attribute_permissions( computed_attribute_id, **kwargs ): - """(BETA) Get Computed Attribute Permissions # noqa: E501 + """Get Computed Attribute Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -12204,9 +12589,9 @@ def create_raw_export( raw_export_request, **kwargs ): - """(EXPERIMENTAL) Create raw export request # noqa: E501 + """Create raw export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14792,9 +15177,9 @@ def get_raw_export( export_id, **kwargs ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 + """Retrieve exported files # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -16680,7 +17065,7 @@ def manage_computed_attribute_permissions( manage_computed_attribute_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Computed Attribute # noqa: E501 + """Manage Permissions for a Computed Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17127,7 +17512,7 @@ def manage_metric_permissions( manage_metric_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Metric # noqa: E501 + """Manage Permissions for a Metric # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17300,7 +17685,7 @@ def manage_visualization_permissions( manage_visualization_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Visualization # noqa: E501 + """Manage Permissions for a Visualization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17721,7 +18106,7 @@ def metric_permissions( metric_id, **kwargs ): - """(BETA) Get Metric Permissions # noqa: E501 + """Get Metric Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17801,13 +18186,181 @@ def metric_permissions( metric_id return self.metric_permissions_endpoint.call_with_http_info(**kwargs) + def organization_localization_issue_workspaces( + self, + type, + locale, + **kwargs + ): + """(BETA) Workspaces with a localization issue. # noqa: E501 + + (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_issue_workspaces(type, locale, async_req=True) + >>> result = thread.get() + + Args: + type (str): The type of the issue. + locale (str): The language of the issue. + + Keyword Args: + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _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: + LocalizationIssueWorkspaces + 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['type'] = \ + type + kwargs['locale'] = \ + locale + return self.organization_localization_issue_workspaces_endpoint.call_with_http_info(**kwargs) + + def organization_localization_issues( + self, + **kwargs + ): + """(BETA) Localization issues of the organization. # noqa: E501 + + (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_issues(async_req=True) + >>> result = thread.get() + + + 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: + LocalizationIssues + 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) + return self.organization_localization_issues_endpoint.call_with_http_info(**kwargs) + def organization_localization_statistics( self, **kwargs ): - """(BETA) Languages with translations in the organization. # noqa: E501 + """Languages with translations in the organization. # noqa: E501 - (BETA) Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 + Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17883,9 +18436,9 @@ def organization_localization_usage( self, **kwargs ): - """(BETA) Languages used in the organization. # noqa: E501 + """Languages used in the organization. # noqa: E501 - (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 + Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -17961,9 +18514,9 @@ def organization_localization_usage_users( self, **kwargs ): - """(BETA) Users who set a language themselves. # noqa: E501 + """Users who set a language themselves. # noqa: E501 - (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -18045,9 +18598,9 @@ def organization_localization_usage_workspaces( self, **kwargs ): - """(BETA) Workspaces that use a language. # noqa: E501 + """Workspaces that use a language. # noqa: E501 - (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -20683,22 +21236,24 @@ def staging_upload( file return self.staging_upload_endpoint.call_with_http_info(**kwargs) - def switch_active_identity_provider( + def stream_execution_progress( self, - switch_identity_provider_request, + workspace_id, + execution_id, **kwargs ): - """Switch Active Identity Provider # noqa: E501 + """(EXPERIMENTAL) Stream the live progress of an AFM execution # noqa: E501 - Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 + Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.switch_active_identity_provider(switch_identity_provider_request, async_req=True) + >>> thread = api.stream_execution_progress(workspace_id, execution_id, async_req=True) >>> result = thread.get() Args: - switch_identity_provider_request (SwitchIdentityProviderRequest): + workspace_id (str): Workspace identifier + execution_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -20733,7 +21288,7 @@ def switch_active_identity_provider( async_req (bool): execute request asynchronously Returns: - None + [dict] If the method is called asynchronously, returns the request thread. """ @@ -20762,10 +21317,95 @@ def switch_active_identity_provider( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['switch_identity_provider_request'] = \ - switch_identity_provider_request - return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) - + kwargs['workspace_id'] = \ + workspace_id + kwargs['execution_id'] = \ + execution_id + return self.stream_execution_progress_endpoint.call_with_http_info(**kwargs) + + def switch_active_identity_provider( + self, + switch_identity_provider_request, + **kwargs + ): + """Switch Active Identity Provider # noqa: E501 + + Switch the active identity provider for the organization. Requires MANAGE permission on the organization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.switch_active_identity_provider(switch_identity_provider_request, async_req=True) + >>> result = thread.get() + + Args: + switch_identity_provider_request (SwitchIdentityProviderRequest): + + 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['switch_identity_provider_request'] = \ + switch_identity_provider_request + return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) + def sync_metadata( self, **kwargs @@ -22352,6 +22992,89 @@ def unsubscribe_workspace_automations( workspace_id return self.unsubscribe_workspace_automations_endpoint.call_with_http_info(**kwargs) + def validate_embedding_origin( + self, + validate_embedding_origin_request, + **kwargs + ): + """Validate an embedding origin. # noqa: E501 + + Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_embedding_origin(validate_embedding_origin_request, async_req=True) + >>> result = thread.get() + + Args: + validate_embedding_origin_request (ValidateEmbeddingOriginRequest): + + 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: + ValidateEmbeddingOriginResponse + 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['validate_embedding_origin_request'] = \ + validate_embedding_origin_request + return self.validate_embedding_origin_endpoint.call_with_http_info(**kwargs) + def validate_llm_endpoint( self, **kwargs @@ -22519,7 +23242,7 @@ def visualization_permissions( visualization_object_id, **kwargs ): - """(BETA) Get Visualization Permissions # noqa: E501 + """Get Visualization Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -22599,14 +23322,97 @@ def visualization_permissions( visualization_object_id return self.visualization_permissions_endpoint.call_with_http_info(**kwargs) + def workspace_localization_issues( + self, + workspace_id, + **kwargs + ): + """(BETA) Localization issues of the workspace. # noqa: E501 + + (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_issues(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + 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: + LocalizationIssues + 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.workspace_localization_issues_endpoint.call_with_http_info(**kwargs) + def workspace_localization_statistics( self, workspace_id, **kwargs ): - """(BETA) Languages with translations in the workspace. # noqa: E501 + """Languages with translations in the workspace. # noqa: E501 - (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. # noqa: E501 + Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -22617,6 +23423,7 @@ def workspace_localization_statistics( workspace_id (str): Keyword Args: + include_coverage (bool): (BETA) Adds translation counts for the workspace and each parent, root first.. [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 @@ -22687,9 +23494,9 @@ def workspace_localization_usage( workspace_id, **kwargs ): - """(BETA) Languages used in the workspace. # noqa: E501 + """Languages used in the workspace. # noqa: E501 - (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. # noqa: E501 + Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -22765,14 +23572,103 @@ def workspace_localization_usage( workspace_id return self.workspace_localization_usage_endpoint.call_with_http_info(**kwargs) + def workspace_localization_usage_child_workspaces( + self, + workspace_id, + **kwargs + ): + """(BETA) Workspaces below the workspace that use a language. # noqa: E501 + + (BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage_child_workspaces(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + value (str): Language tag that the workspace gets.. [optional] + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _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: + LocalizationUsageWorkspaces + 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.workspace_localization_usage_child_workspaces_endpoint.call_with_http_info(**kwargs) + def workspace_localization_usage_users( self, workspace_id, **kwargs ): - """(BETA) Workspace members who get a language. # noqa: E501 + """Workspace members who get a language. # noqa: E501 - (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/aggregated_fact_controller_api.py b/gooddata-api-client/gooddata_api_client/api/aggregated_fact_controller_api.py index 98849ab31..3a442239c 100644 --- a/gooddata-api-client/gooddata_api_client/api/aggregated_fact_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/aggregated_fact_controller_api.py @@ -522,7 +522,7 @@ def search_entities_aggregated_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py index e7ca337c1..fd27db3c5 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py @@ -721,6 +721,64 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.refresh_ai_lake_data_source_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh', + 'operation_id': 'refresh_ai_lake_data_source', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'instance_id', + 'data_source_id', + 'operation_id', + ], + 'required': [ + 'instance_id', + 'data_source_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'instance_id': + (str,), + 'data_source_id': + (str,), + 'operation_id': + (str,), + }, + 'attribute_map': { + 'instance_id': 'instanceId', + 'data_source_id': 'dataSourceId', + 'operation_id': 'operation-id', + }, + 'location_map': { + 'instance_id': 'path', + 'data_source_id': 'path', + 'operation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.remove_ai_lake_database_data_source_endpoint = _Endpoint( settings={ 'response_type': (RemoveDatabaseDataSourceResponse,), @@ -1820,6 +1878,94 @@ def provision_ai_lake_database_instance( provision_database_instance_request return self.provision_ai_lake_database_instance_endpoint.call_with_http_info(**kwargs) + def refresh_ai_lake_data_source( + self, + instance_id, + data_source_id, + **kwargs + ): + """(BETA) Refresh an AI Lake data source # noqa: E501 + + (BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.refresh_ai_lake_data_source(instance_id, data_source_id, async_req=True) + >>> result = thread.get() + + Args: + instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. + data_source_id (str): Data source identifier. + + Keyword Args: + operation_id (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: + 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['instance_id'] = \ + instance_id + kwargs['data_source_id'] = \ + data_source_id + return self.refresh_ai_lake_data_source_endpoint.call_with_http_info(**kwargs) + def remove_ai_lake_database_data_source( self, instance_id, diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py index 791228f40..fe538b1e9 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py @@ -546,6 +546,64 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.refresh_ai_lake_data_source_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh', + 'operation_id': 'refresh_ai_lake_data_source', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'instance_id', + 'data_source_id', + 'operation_id', + ], + 'required': [ + 'instance_id', + 'data_source_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'instance_id': + (str,), + 'data_source_id': + (str,), + 'operation_id': + (str,), + }, + 'attribute_map': { + 'instance_id': 'instanceId', + 'data_source_id': 'dataSourceId', + 'operation_id': 'operation-id', + }, + 'location_map': { + 'instance_id': 'path', + 'data_source_id': 'path', + 'operation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.remove_ai_lake_database_data_source_endpoint = _Endpoint( settings={ 'response_type': (RemoveDatabaseDataSourceResponse,), @@ -1333,6 +1391,94 @@ def provision_ai_lake_database_instance( provision_database_instance_request return self.provision_ai_lake_database_instance_endpoint.call_with_http_info(**kwargs) + def refresh_ai_lake_data_source( + self, + instance_id, + data_source_id, + **kwargs + ): + """(BETA) Refresh an AI Lake data source # noqa: E501 + + (BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.refresh_ai_lake_data_source(instance_id, data_source_id, async_req=True) + >>> result = thread.get() + + Args: + instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. + data_source_id (str): Data source identifier. + + Keyword Args: + operation_id (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: + 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['instance_id'] = \ + instance_id + kwargs['data_source_id'] = \ + data_source_id + return self.refresh_ai_lake_data_source_endpoint.call_with_http_info(**kwargs) + def remove_ai_lake_database_data_source( self, instance_id, diff --git a/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py index c824b954a..e63d1b592 100644 --- a/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py @@ -1149,7 +1149,7 @@ def search_entities_analytical_dashboards( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py index f46f74cd4..6e567b555 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py @@ -609,7 +609,7 @@ def patch_entity_attributes( json_api_attribute_patch_document, **kwargs ): - """Patch an Attribute (beta) # noqa: E501 + """Patch an Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -700,7 +700,7 @@ def search_entities_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py index 11340aecf..541fd4c29 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchies_api.py @@ -1097,7 +1097,7 @@ def search_entities_attribute_hierarchies( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py index adf7c3845..e6bdb63f3 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_hierarchy_controller_api.py @@ -1097,7 +1097,7 @@ def search_entities_attribute_hierarchies( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/attributes_api.py b/gooddata-api-client/gooddata_api_client/api/attributes_api.py index d39021356..506332c83 100644 --- a/gooddata-api-client/gooddata_api_client/api/attributes_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attributes_api.py @@ -609,7 +609,7 @@ def patch_entity_attributes( json_api_attribute_patch_document, **kwargs ): - """Patch an Attribute (beta) # noqa: E501 + """Patch an Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -700,7 +700,7 @@ def search_entities_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py index 85d685aa6..d3b310b43 100644 --- a/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py @@ -1162,7 +1162,7 @@ def search_entities_automations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/automation_result_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_result_controller_api.py index beef99ee0..76a67c860 100644 --- a/gooddata-api-client/gooddata_api_client/api/automation_result_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automation_result_controller_api.py @@ -118,7 +118,7 @@ def search_entities_automation_results( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/automations_api.py b/gooddata-api-client/gooddata_api_client/api/automations_api.py index bfdd1b8a6..81d6c7f9d 100644 --- a/gooddata-api-client/gooddata_api_client/api/automations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automations_api.py @@ -2619,7 +2619,7 @@ def search_entities_automation_results( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2707,7 +2707,7 @@ def search_entities_automations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/computation_api.py b/gooddata-api-client/gooddata_api_client/api/computation_api.py index 9c1f8c4a2..f695b803f 100644 --- a/gooddata-api-client/gooddata_api_client/api/computation_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computation_api.py @@ -1248,6 +1248,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.stream_execution_progress_endpoint = _Endpoint( + settings={ + 'response_type': ([dict],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId}', + 'operation_id': 'stream_execution_progress', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'execution_id', + ], + 'required': [ + 'workspace_id', + 'execution_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'execution_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'execution_id': 'executionId', + }, + 'location_map': { + 'workspace_id': 'path', + 'execution_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/event-stream' + ], + 'content_type': [], + }, + api_client=api_client + ) def cancel_executions( self, @@ -2747,3 +2809,90 @@ def retrieve_result_binary( result_id return self.retrieve_result_binary_endpoint.call_with_http_info(**kwargs) + def stream_execution_progress( + self, + workspace_id, + execution_id, + **kwargs + ): + """(EXPERIMENTAL) Stream the live progress of an AFM execution # noqa: E501 + + Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.stream_execution_progress(workspace_id, execution_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + execution_id (str): + + 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: + [dict] + 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['execution_id'] = \ + execution_id + return self.stream_execution_progress_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py b/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py index 500e1e955..f7ab9dc95 100644 --- a/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py @@ -1136,7 +1136,7 @@ def search_entities_computed_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py b/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py index 5d355140d..75fd170d0 100644 --- a/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py +++ b/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py @@ -1136,7 +1136,7 @@ def search_entities_computed_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py index af1c41a1c..7bb91455c 100644 --- a/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/custom_application_setting_controller_api.py @@ -1019,7 +1019,7 @@ def search_entities_custom_application_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py b/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py index 82877b1f8..bfeb514c9 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboard_plugin_controller_api.py @@ -1093,7 +1093,7 @@ def search_entities_dashboard_plugins( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py index 0d2ed345f..c3daf3e84 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py @@ -1149,7 +1149,7 @@ def search_entities_analytical_dashboards( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py index 1eae41e4f..1e87769e9 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py @@ -3390,7 +3390,7 @@ def search_entities_user_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3478,7 +3478,7 @@ def search_entities_workspace_data_filter_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3566,7 +3566,7 @@ def search_entities_workspace_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py b/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py index 58adf7926..3b06a3459 100644 --- a/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dataset_controller_api.py @@ -610,7 +610,7 @@ def patch_entity_datasets( json_api_dataset_patch_document, **kwargs ): - """Patch a Dataset (beta) # noqa: E501 + """Patch a Dataset # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -701,7 +701,7 @@ def search_entities_datasets( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/datasets_api.py b/gooddata-api-client/gooddata_api_client/api/datasets_api.py index 53af85ab9..ea73f8e4f 100644 --- a/gooddata-api-client/gooddata_api_client/api/datasets_api.py +++ b/gooddata-api-client/gooddata_api_client/api/datasets_api.py @@ -610,7 +610,7 @@ def patch_entity_datasets( json_api_dataset_patch_document, **kwargs ): - """Patch a Dataset (beta) # noqa: E501 + """Patch a Dataset # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -701,7 +701,7 @@ def search_entities_datasets( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/document_controller_api.py b/gooddata-api-client/gooddata_api_client/api/document_controller_api.py index 746f899ab..4d6f06dc2 100644 --- a/gooddata-api-client/gooddata_api_client/api/document_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/document_controller_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.entity_search_body import EntitySearchBody from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList @@ -498,6 +499,80 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.search_entities_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/search', + 'operation_id': 'search_entities_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.update_entity_documents_endpoint = _Endpoint( settings={ 'response_type': (JsonApiPublisherDocumentOutDocument,), @@ -1032,6 +1107,94 @@ def patch_entity_documents( json_api_publisher_document_patch_document return self.patch_entity_documents_endpoint.call_with_http_info(**kwargs) + def search_entities_documents( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_documents(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _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: + JsonApiPublisherDocumentOutList + 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['entity_search_body'] = \ + entity_search_body + return self.search_entities_documents_endpoint.call_with_http_info(**kwargs) + def update_entity_documents( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/entities_api.py b/gooddata-api-client/gooddata_api_client/api/entities_api.py index 8bdf6d7db..b1362a007 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -22470,6 +22470,80 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.search_entities_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/search', + 'operation_id': 'search_entities_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.search_entities_export_definitions_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportDefinitionOutList,), @@ -46508,7 +46582,7 @@ def patch_entity_attributes( json_api_attribute_patch_document, **kwargs ): - """Patch an Attribute (beta) # noqa: E501 + """Patch an Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -47404,7 +47478,7 @@ def patch_entity_datasets( json_api_dataset_patch_document, **kwargs ): - """Patch a Dataset (beta) # noqa: E501 + """Patch a Dataset # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -47859,7 +47933,7 @@ def patch_entity_facts( json_api_fact_patch_document, **kwargs ): - """Patch a Fact (beta) # noqa: E501 + """Patch a Fact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -48402,7 +48476,7 @@ def patch_entity_labels( json_api_label_patch_document, **kwargs ): - """Patch a Label (beta) # noqa: E501 + """Patch a Label # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -50660,7 +50734,7 @@ def search_entities_aggregated_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -50748,7 +50822,7 @@ def search_entities_analytical_dashboards( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -50836,7 +50910,7 @@ def search_entities_attribute_hierarchies( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -50924,7 +50998,7 @@ def search_entities_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51012,7 +51086,7 @@ def search_entities_automation_results( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51100,7 +51174,7 @@ def search_entities_automations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51188,7 +51262,7 @@ def search_entities_computed_attributes( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51276,7 +51350,7 @@ def search_entities_custom_application_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51364,7 +51438,7 @@ def search_entities_dashboard_plugins( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51452,7 +51526,7 @@ def search_entities_datasets( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51534,13 +51608,101 @@ def search_entities_datasets( entity_search_body return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) + def search_entities_documents( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_documents(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _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: + JsonApiPublisherDocumentOutList + 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['entity_search_body'] = \ + entity_search_body + return self.search_entities_documents_endpoint.call_with_http_info(**kwargs) + def search_entities_export_definitions( self, workspace_id, entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51628,7 +51790,7 @@ def search_entities_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51716,7 +51878,7 @@ def search_entities_filter_contexts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51804,7 +51966,7 @@ def search_entities_filter_views( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51892,7 +52054,7 @@ def search_entities_knowledge_recommendations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -51980,7 +52142,7 @@ def search_entities_labels( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52068,7 +52230,7 @@ def search_entities_memory_items( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52156,7 +52318,7 @@ def search_entities_metrics( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52244,7 +52406,7 @@ def search_entities_parameters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52332,7 +52494,7 @@ def search_entities_user_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52420,7 +52582,7 @@ def search_entities_visualization_objects( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52508,7 +52670,7 @@ def search_entities_workspace_data_filter_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52596,7 +52758,7 @@ def search_entities_workspace_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -52684,7 +52846,7 @@ def search_entities_workspace_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py b/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py index 9e255f495..1fdafdd79 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_definition_controller_api.py @@ -1123,7 +1123,7 @@ def search_entities_export_definitions( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py index 0cbc42303..2e58d1896 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_definitions_api.py @@ -1123,7 +1123,7 @@ def search_entities_export_definitions( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py index 757f0e551..81132558c 100644 --- a/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py @@ -600,7 +600,7 @@ def patch_entity_facts( json_api_fact_patch_document, **kwargs ): - """Patch a Fact (beta) # noqa: E501 + """Patch a Fact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -691,7 +691,7 @@ def search_entities_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/facts_api.py b/gooddata-api-client/gooddata_api_client/api/facts_api.py index 688baa544..532a3e542 100644 --- a/gooddata-api-client/gooddata_api_client/api/facts_api.py +++ b/gooddata-api-client/gooddata_api_client/api/facts_api.py @@ -1079,7 +1079,7 @@ def patch_entity_facts( json_api_fact_patch_document, **kwargs ): - """Patch a Fact (beta) # noqa: E501 + """Patch a Fact # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1170,7 +1170,7 @@ def search_entities_aggregated_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1258,7 +1258,7 @@ def search_entities_facts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py index 776db1788..97a589fe3 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py @@ -1108,7 +1108,7 @@ def search_entities_filter_contexts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py index d11a5d858..14d1affed 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py @@ -1108,7 +1108,7 @@ def search_entities_filter_contexts( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py b/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py index 2a01e7622..73d20357c 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_view_controller_api.py @@ -1060,7 +1060,7 @@ def search_entities_filter_views( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True 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 b992ff264..c95c4acaa 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 @@ -1259,7 +1259,7 @@ def search_entities_filter_views( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/knowledge_recommendation_controller_api.py b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendation_controller_api.py index 6df64a375..c32eb5e0c 100644 --- a/gooddata-api-client/gooddata_api_client/api/knowledge_recommendation_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendation_controller_api.py @@ -1098,7 +1098,7 @@ def search_entities_knowledge_recommendations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py index ee3b73cb2..63c07ff57 100644 --- a/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py @@ -1098,7 +1098,7 @@ def search_entities_knowledge_recommendations( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/label_controller_api.py b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py index 392dc2517..9b056367d 100644 --- a/gooddata-api-client/gooddata_api_client/api/label_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py @@ -600,7 +600,7 @@ def patch_entity_labels( json_api_label_patch_document, **kwargs ): - """Patch a Label (beta) # noqa: E501 + """Patch a Label # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -691,7 +691,7 @@ def search_entities_labels( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/labels_api.py b/gooddata-api-client/gooddata_api_client/api/labels_api.py index 18a8d78ad..5f265e1ee 100644 --- a/gooddata-api-client/gooddata_api_client/api/labels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/labels_api.py @@ -600,7 +600,7 @@ def patch_entity_labels( json_api_label_patch_document, **kwargs ): - """Patch a Label (beta) # noqa: E501 + """Patch a Label # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -691,7 +691,7 @@ def search_entities_labels( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/localization_api.py b/gooddata-api-client/gooddata_api_client/api/localization_api.py index 1e28978a3..f04ae3a4d 100644 --- a/gooddata-api-client/gooddata_api_client/api/localization_api.py +++ b/gooddata-api-client/gooddata_api_client/api/localization_api.py @@ -22,6 +22,8 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.localization_issue_workspaces import LocalizationIssueWorkspaces +from gooddata_api_client.model.localization_issues import LocalizationIssues from gooddata_api_client.model.localization_statistics import LocalizationStatistics from gooddata_api_client.model.localization_usage import LocalizationUsage from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers @@ -40,6 +42,125 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.organization_localization_issue_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssueWorkspaces,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/issues/workspaces', + 'operation_id': 'organization_localization_issue_workspaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'type', + 'locale', + 'name', + 'page', + 'size', + ], + 'required': [ + 'type', + 'locale', + ], + 'nullable': [ + ], + 'enum': [ + 'type', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('type',): { + + "MISSING_TRANSLATION": "METADATA_MISSING_TRANSLATION", + "LANGUAGE_MISMATCH": "METADATA_LANGUAGE_MISMATCH", + "UNUSED_TRANSLATION": "METADATA_UNUSED_TRANSLATION" + }, + }, + 'openapi_types': { + 'type': + (str,), + 'locale': + (str,), + 'name': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'type': 'type', + 'locale': 'locale', + 'name': 'name', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'type': 'query', + 'locale': 'query', + 'name': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_issues_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssues,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/issues', + 'operation_id': 'organization_localization_issues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.organization_localization_statistics_endpoint = _Endpoint( settings={ 'response_type': (LocalizationStatistics,), @@ -302,6 +423,55 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.workspace_localization_issues_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationIssues,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/issues', + 'operation_id': 'workspace_localization_issues', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.workspace_localization_statistics_endpoint = _Endpoint( settings={ 'response_type': (LocalizationStatistics,), @@ -314,6 +484,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', + 'include_coverage', ], 'required': [ 'workspace_id', @@ -333,12 +504,16 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), + 'include_coverage': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'include_coverage': 'includeCoverage', }, 'location_map': { 'workspace_id': 'path', + 'include_coverage': 'query', }, 'collection_format_map': { } @@ -400,6 +575,102 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.workspace_localization_usage_child_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageWorkspaces,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces', + 'operation_id': 'workspace_localization_usage_child_workspaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'workspace_id': 'path', + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.workspace_localization_usage_users_endpoint = _Endpoint( settings={ 'response_type': (LocalizationUsageUsers,), @@ -497,21 +768,29 @@ def __init__(self, api_client=None): api_client=api_client ) - def organization_localization_statistics( + def organization_localization_issue_workspaces( self, + type, + locale, **kwargs ): - """(BETA) Languages with translations in the organization. # noqa: E501 + """(BETA) Workspaces with a localization issue. # noqa: E501 - (BETA) Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 + (BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.organization_localization_statistics(async_req=True) + >>> thread = api.organization_localization_issue_workspaces(type, locale, async_req=True) >>> result = thread.get() + Args: + type (str): The type of the issue. + locale (str): The language of the issue. Keyword Args: + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 _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 @@ -544,7 +823,7 @@ def organization_localization_statistics( async_req (bool): execute request asynchronously Returns: - LocalizationStatistics + LocalizationIssueWorkspaces If the method is called asynchronously, returns the request thread. """ @@ -573,19 +852,23 @@ def organization_localization_statistics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.organization_localization_statistics_endpoint.call_with_http_info(**kwargs) + kwargs['type'] = \ + type + kwargs['locale'] = \ + locale + return self.organization_localization_issue_workspaces_endpoint.call_with_http_info(**kwargs) - def organization_localization_usage( + def organization_localization_issues( self, **kwargs ): - """(BETA) Languages used in the organization. # noqa: E501 + """(BETA) Localization issues of the organization. # noqa: E501 - (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 + (BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.organization_localization_usage(async_req=True) + >>> thread = api.organization_localization_issues(async_req=True) >>> result = thread.get() @@ -622,7 +905,7 @@ def organization_localization_usage( async_req (bool): execute request asynchronously Returns: - LocalizationUsage + LocalizationIssues If the method is called asynchronously, returns the request thread. """ @@ -651,29 +934,185 @@ def organization_localization_usage( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.organization_localization_usage_endpoint.call_with_http_info(**kwargs) + return self.organization_localization_issues_endpoint.call_with_http_info(**kwargs) - def organization_localization_usage_users( + def organization_localization_statistics( self, **kwargs ): - """(BETA) Users who set a language themselves. # noqa: E501 + """Languages with translations in the organization. # noqa: E501 - (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.organization_localization_usage_users(async_req=True) + >>> thread = api.organization_localization_statistics(async_req=True) >>> result = thread.get() Keyword Args: - value (str): Language tag that the user sets.. [optional] - name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] - setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] - source (str): Where the value comes from.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _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: + LocalizationStatistics + 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) + return self.organization_localization_statistics_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage( + self, + **kwargs + ): + """Languages used in the organization. # noqa: E501 + + Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage(async_req=True) + >>> result = thread.get() + + + 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: + LocalizationUsage + 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) + return self.organization_localization_usage_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage_users( + self, + **kwargs + ): + """Users who set a language themselves. # noqa: E501 + + Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage_users(async_req=True) + >>> result = thread.get() + + + Keyword Args: + value (str): Language tag that the user sets.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 _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 @@ -741,9 +1180,9 @@ def organization_localization_usage_workspaces( self, **kwargs ): - """(BETA) Workspaces that use a language. # noqa: E501 + """Workspaces that use a language. # noqa: E501 - (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -821,14 +1260,97 @@ def organization_localization_usage_workspaces( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.organization_localization_usage_workspaces_endpoint.call_with_http_info(**kwargs) + def workspace_localization_issues( + self, + workspace_id, + **kwargs + ): + """(BETA) Localization issues of the workspace. # noqa: E501 + + (BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_issues(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + 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: + LocalizationIssues + 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.workspace_localization_issues_endpoint.call_with_http_info(**kwargs) + def workspace_localization_statistics( self, workspace_id, **kwargs ): - """(BETA) Languages with translations in the workspace. # noqa: E501 + """Languages with translations in the workspace. # noqa: E501 - (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. # noqa: E501 + Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -839,6 +1361,7 @@ def workspace_localization_statistics( workspace_id (str): Keyword Args: + include_coverage (bool): (BETA) Adds translation counts for the workspace and each parent, root first.. [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 @@ -909,9 +1432,9 @@ def workspace_localization_usage( workspace_id, **kwargs ): - """(BETA) Languages used in the workspace. # noqa: E501 + """Languages used in the workspace. # noqa: E501 - (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. # noqa: E501 + Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -987,14 +1510,103 @@ def workspace_localization_usage( workspace_id return self.workspace_localization_usage_endpoint.call_with_http_info(**kwargs) + def workspace_localization_usage_child_workspaces( + self, + workspace_id, + **kwargs + ): + """(BETA) Workspaces below the workspace that use a language. # noqa: E501 + + (BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage_child_workspaces(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + value (str): Language tag that the workspace gets.. [optional] + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _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: + LocalizationUsageWorkspaces + 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.workspace_localization_usage_child_workspaces_endpoint.call_with_http_info(**kwargs) + def workspace_localization_usage_users( self, workspace_id, **kwargs ): - """(BETA) Workspace members who get a language. # noqa: E501 + """Workspace members who get a language. # noqa: E501 - (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language. # noqa: E501 + Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/memory_item_controller_api.py b/gooddata-api-client/gooddata_api_client/api/memory_item_controller_api.py index eb2c8f8ea..f078e0489 100644 --- a/gooddata-api-client/gooddata_api_client/api/memory_item_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/memory_item_controller_api.py @@ -1093,7 +1093,7 @@ def search_entities_memory_items( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/memory_items_api.py b/gooddata-api-client/gooddata_api_client/api/memory_items_api.py index 4471310bd..e4644cda2 100644 --- a/gooddata-api-client/gooddata_api_client/api/memory_items_api.py +++ b/gooddata-api-client/gooddata_api_client/api/memory_items_api.py @@ -1977,7 +1977,7 @@ def search_entities_memory_items( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py index 6e63da7b8..37742cf23 100644 --- a/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py @@ -1136,7 +1136,7 @@ def search_entities_metrics( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/metrics_api.py b/gooddata-api-client/gooddata_api_client/api/metrics_api.py index 1ddf6ee02..2b8636f7a 100644 --- a/gooddata-api-client/gooddata_api_client/api/metrics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metrics_api.py @@ -1136,7 +1136,7 @@ def search_entities_metrics( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/parameter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/parameter_controller_api.py index 2f5f37932..bba320e5f 100644 --- a/gooddata-api-client/gooddata_api_client/api/parameter_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/parameter_controller_api.py @@ -1093,7 +1093,7 @@ def search_entities_parameters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/parameters_api.py b/gooddata-api-client/gooddata_api_client/api/parameters_api.py index 930f29019..3069040cc 100644 --- a/gooddata-api-client/gooddata_api_client/api/parameters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/parameters_api.py @@ -1093,7 +1093,7 @@ def search_entities_parameters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/permissions_api.py b/gooddata-api-client/gooddata_api_client/api/permissions_api.py index b196d6c0e..653051cfa 100644 --- a/gooddata-api-client/gooddata_api_client/api/permissions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/permissions_api.py @@ -1651,7 +1651,7 @@ def computed_attribute_permissions( computed_attribute_id, **kwargs ): - """(BETA) Get Computed Attribute Permissions # noqa: E501 + """Get Computed Attribute Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2413,7 +2413,7 @@ def manage_computed_attribute_permissions( manage_computed_attribute_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Computed Attribute # noqa: E501 + """Manage Permissions for a Computed Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2860,7 +2860,7 @@ def manage_metric_permissions( manage_metric_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Metric # noqa: E501 + """Manage Permissions for a Metric # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3033,7 +3033,7 @@ def manage_visualization_permissions( manage_visualization_permissions_request_inner, **kwargs ): - """(BETA) Manage Permissions for a Visualization # noqa: E501 + """Manage Permissions for a Visualization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3209,7 +3209,7 @@ def metric_permissions( metric_id, **kwargs ): - """(BETA) Get Metric Permissions # noqa: E501 + """Get Metric Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3639,7 +3639,7 @@ def visualization_permissions( visualization_object_id, **kwargs ): - """(BETA) Get Visualization Permissions # noqa: E501 + """Get Visualization Permissions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/plugins_api.py b/gooddata-api-client/gooddata_api_client/api/plugins_api.py index bde6a58bc..f273f0804 100644 --- a/gooddata-api-client/gooddata_api_client/api/plugins_api.py +++ b/gooddata-api-client/gooddata_api_client/api/plugins_api.py @@ -1093,7 +1093,7 @@ def search_entities_dashboard_plugins( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py b/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py index b46e03b72..b104692c1 100644 --- a/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py +++ b/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.entity_search_body import EntitySearchBody from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList @@ -1392,6 +1393,80 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.search_entities_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/search', + 'operation_id': 'search_entities_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.update_entity_document_templates_endpoint = _Endpoint( settings={ 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), @@ -2985,6 +3060,94 @@ def patch_entity_page_templates( json_api_publisher_document_page_template_patch_document return self.patch_entity_page_templates_endpoint.call_with_http_info(**kwargs) + def search_entities_documents( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_documents(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _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: + JsonApiPublisherDocumentOutList + 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['entity_search_body'] = \ + entity_search_body + return self.search_entities_documents_endpoint.call_with_http_info(**kwargs) + def update_entity_document_templates( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py index 7066a0f4d..9bd1e6702 100644 --- a/gooddata-api-client/gooddata_api_client/api/raw_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/raw_export_api.py @@ -157,9 +157,9 @@ def create_raw_export( raw_export_request, **kwargs ): - """(EXPERIMENTAL) Create raw export request # noqa: E501 + """Create raw export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -244,9 +244,9 @@ def get_raw_export( export_id, **kwargs ): - """(EXPERIMENTAL) Retrieve exported files # noqa: E501 + """Retrieve exported files # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py b/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py index e228379e3..e7d247fc6 100644 --- a/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/reporting_settings_api.py @@ -24,6 +24,8 @@ ) from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.model.validate_embedding_origin_request import ValidateEmbeddingOriginRequest +from gooddata_api_client.model.validate_embedding_origin_response import ValidateEmbeddingOriginResponse class ReportingSettingsApi(object): @@ -139,6 +141,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.validate_embedding_origin_endpoint = _Endpoint( + settings={ + 'response_type': (ValidateEmbeddingOriginResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/validateEmbeddingOrigin', + 'operation_id': 'validate_embedding_origin', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'validate_embedding_origin_request', + ], + 'required': [ + 'validate_embedding_origin_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'validate_embedding_origin_request': + (ValidateEmbeddingOriginRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'validate_embedding_origin_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def resolve_all_settings_without_workspace( self, @@ -303,3 +355,86 @@ def resolve_settings_without_workspace( resolve_settings_request return self.resolve_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + def validate_embedding_origin( + self, + validate_embedding_origin_request, + **kwargs + ): + """Validate an embedding origin. # noqa: E501 + + Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.validate_embedding_origin(validate_embedding_origin_request, async_req=True) + >>> result = thread.get() + + Args: + validate_embedding_origin_request (ValidateEmbeddingOriginRequest): + + 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: + ValidateEmbeddingOriginResponse + 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['validate_embedding_origin_request'] = \ + validate_embedding_origin_request + return self.validate_embedding_origin_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py index 85a08f9fb..1e733ed11 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py @@ -1133,7 +1133,7 @@ def search_entities_user_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py index 10de02457..03d95e058 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py @@ -1136,7 +1136,7 @@ def search_entities_visualization_objects( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py index 09b700df2..e09bf6b1a 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py @@ -1136,7 +1136,7 @@ def search_entities_visualization_objects( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py index ac71288d0..94fe7e12b 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_controller_api.py @@ -1087,7 +1087,7 @@ def search_entities_workspace_data_filters( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py index 22c64e143..e62040fc5 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_data_filter_setting_controller_api.py @@ -1087,7 +1087,7 @@ def search_entities_workspace_data_filter_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py index 1c00787f5..96d56954e 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspace_setting_controller_api.py @@ -1019,7 +1019,7 @@ def search_entities_workspace_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py index 399234853..3661a543f 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_settings_api.py @@ -2112,7 +2112,7 @@ def search_entities_custom_application_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2200,7 +2200,7 @@ def search_entities_workspace_settings( entity_search_body, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """The search endpoint # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/model/computation_profile.py b/gooddata-api-client/gooddata_api_client/model/computation_profile.py new file mode 100644 index 000000000..34c60e48d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/computation_profile.py @@ -0,0 +1,304 @@ +""" + 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.computation_profile_source import ComputationProfileSource + globals()['ComputationProfileSource'] = ComputationProfileSource + + +class ComputationProfile(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 { + 'computed_at': (int,), # noqa: E501 + 'sources': ([ComputationProfileSource],), # noqa: E501 + 'v': (int,), # noqa: E501 + 'finished_at': (int,), # noqa: E501 + 'finished_at_approx': (str,), # noqa: E501 + 'started_at': (int,), # noqa: E501 + 'total_duration_ms': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'computed_at': 'computedAt', # noqa: E501 + 'sources': 'sources', # noqa: E501 + 'v': 'v', # noqa: E501 + 'finished_at': 'finishedAt', # noqa: E501 + 'finished_at_approx': 'finishedAtApprox', # noqa: E501 + 'started_at': 'startedAt', # noqa: E501 + 'total_duration_ms': 'totalDurationMs', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, computed_at, sources, v, *args, **kwargs): # noqa: E501 + """ComputationProfile - a model defined in OpenAPI + + Args: + computed_at (int): + sources ([ComputationProfileSource]): + v (int): + + 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,) + finished_at (int): [optional] # noqa: E501 + finished_at_approx (str): [optional] # noqa: E501 + started_at (int): [optional] # noqa: E501 + total_duration_ms (int): [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.computed_at = computed_at + self.sources = sources + self.v = v + 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, computed_at, sources, v, *args, **kwargs): # noqa: E501 + """ComputationProfile - a model defined in OpenAPI + + Args: + computed_at (int): + sources ([ComputationProfileSource]): + v (int): + + 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,) + finished_at (int): [optional] # noqa: E501 + finished_at_approx (str): [optional] # noqa: E501 + started_at (int): [optional] # noqa: E501 + total_duration_ms (int): [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.computed_at = computed_at + self.sources = sources + self.v = v + 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/computation_profile_source.py b/gooddata-api-client/gooddata_api_client/model/computation_profile_source.py new file mode 100644 index 000000000..b0fb351dd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/computation_profile_source.py @@ -0,0 +1,308 @@ +""" + 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 ComputationProfileSource(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 + """ + 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 { + 'data_source_id': (str,), # noqa: E501 + 'data_source_name': (str,), # noqa: E501 + 'db_duration_ms': (int,), # noqa: E501 + 'finished_at': (int,), # noqa: E501 + 'query_duration_ms': (int,), # noqa: E501 + 'query_finished_at': (int,), # noqa: E501 + 'query_requested_at': (int,), # noqa: E501 + 'query_started_at': (int,), # noqa: E501 + 'result_id': (str,), # noqa: E501 + 'rows': (int,), # noqa: E501 + 'streaming_started_at': (int,), # noqa: E501 + 'total_duration_ms': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_source_id': 'dataSourceId', # noqa: E501 + 'data_source_name': 'dataSourceName', # noqa: E501 + 'db_duration_ms': 'dbDurationMs', # noqa: E501 + 'finished_at': 'finishedAt', # noqa: E501 + 'query_duration_ms': 'queryDurationMs', # noqa: E501 + 'query_finished_at': 'queryFinishedAt', # noqa: E501 + 'query_requested_at': 'queryRequestedAt', # noqa: E501 + 'query_started_at': 'queryStartedAt', # noqa: E501 + 'result_id': 'resultId', # noqa: E501 + 'rows': 'rows', # noqa: E501 + 'streaming_started_at': 'streamingStartedAt', # noqa: E501 + 'total_duration_ms': 'totalDurationMs', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ComputationProfileSource - a model defined in OpenAPI + + 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,) + data_source_id (str): [optional] # noqa: E501 + data_source_name (str): [optional] # noqa: E501 + db_duration_ms (int): [optional] # noqa: E501 + finished_at (int): [optional] # noqa: E501 + query_duration_ms (int): [optional] # noqa: E501 + query_finished_at (int): [optional] # noqa: E501 + query_requested_at (int): [optional] # noqa: E501 + query_started_at (int): [optional] # noqa: E501 + result_id (str): [optional] # noqa: E501 + rows (int): [optional] # noqa: E501 + streaming_started_at (int): [optional] # noqa: E501 + total_duration_ms (int): [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__,) + + 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, *args, **kwargs): # noqa: E501 + """ComputationProfileSource - a model defined in OpenAPI + + 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,) + data_source_id (str): [optional] # noqa: E501 + data_source_name (str): [optional] # noqa: E501 + db_duration_ms (int): [optional] # noqa: E501 + finished_at (int): [optional] # noqa: E501 + query_duration_ms (int): [optional] # noqa: E501 + query_finished_at (int): [optional] # noqa: E501 + query_requested_at (int): [optional] # noqa: E501 + query_started_at (int): [optional] # noqa: E501 + result_id (str): [optional] # noqa: E501 + rows (int): [optional] # noqa: E501 + streaming_started_at (int): [optional] # noqa: E501 + total_duration_ms (int): [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__,) + + 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/date_filter.py b/gooddata-api-client/gooddata_api_client/model/date_filter.py index bf72882a3..893cc4077 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/date_filter.py @@ -37,6 +37,8 @@ def lazy_import(): from gooddata_api_client.model.absolute_granularity_date_filter_absolute_granularity_date_filter import AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter from gooddata_api_client.model.all_time_date_filter import AllTimeDateFilter from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter + from gooddata_api_client.model.parameterized_date_filter import ParameterizedDateFilter + from gooddata_api_client.model.parameterized_date_filter_parameterized_date_filter import ParameterizedDateFilterParameterizedDateFilter from gooddata_api_client.model.relative_date_filter import RelativeDateFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilter'] = AbsoluteDateFilter @@ -45,6 +47,8 @@ def lazy_import(): globals()['AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter globals()['AllTimeDateFilter'] = AllTimeDateFilter globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter + globals()['ParameterizedDateFilter'] = ParameterizedDateFilter + globals()['ParameterizedDateFilterParameterizedDateFilter'] = ParameterizedDateFilterParameterizedDateFilter globals()['RelativeDateFilter'] = RelativeDateFilter globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter @@ -104,6 +108,7 @@ def openapi_types(): return { 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 + 'parameterized_date_filter': (ParameterizedDateFilterParameterizedDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 } @@ -116,6 +121,7 @@ def discriminator(): attribute_map = { 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 + 'parameterized_date_filter': 'parameterizedDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 } @@ -161,6 +167,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ @@ -268,6 +275,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ @@ -344,6 +352,7 @@ def _composed_schemas(): AbsoluteDateFilter, AbsoluteGranularityDateFilter, AllTimeDateFilter, + ParameterizedDateFilter, RelativeDateFilter, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/date_range_parameter_definition.py b/gooddata-api-client/gooddata_api_client/model/date_range_parameter_definition.py new file mode 100644 index 000000000..eb80e3008 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/date_range_parameter_definition.py @@ -0,0 +1,287 @@ +""" + 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.date_range_parameter_value import DateRangeParameterValue + globals()['DateRangeParameterValue'] = DateRangeParameterValue + + +class DateRangeParameterDefinition(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',): { + 'DATE_RANGE': "DATE_RANGE", + }, + } + + 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 { + 'default_value': (DateRangeParameterValue,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'default_value': 'defaultValue', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, default_value, *args, **kwargs): # noqa: E501 + """DateRangeParameterDefinition - a model defined in OpenAPI + + Args: + default_value (DateRangeParameterValue): + + Keyword Args: + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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', "DATE_RANGE") + _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.default_value = default_value + 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, default_value, *args, **kwargs): # noqa: E501 + """DateRangeParameterDefinition - a model defined in OpenAPI + + Args: + default_value (DateRangeParameterValue): + + Keyword Args: + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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', "DATE_RANGE") + _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.default_value = default_value + 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/date_range_parameter_value.py b/gooddata-api-client/gooddata_api_client/model/date_range_parameter_value.py new file mode 100644 index 000000000..cfa56c628 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/date_range_parameter_value.py @@ -0,0 +1,288 @@ +""" + 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 DateRangeParameterValue(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 = { + ('granularity',): { + 'YEAR': "YEAR", + 'QUARTER': "QUARTER", + 'MONTH': "MONTH", + 'WEEK': "WEEK", + 'DAY': "DAY", + 'HOUR': "HOUR", + 'MINUTE': "MINUTE", + 'SECOND': "SECOND", + }, + } + + 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 { + 'granularity': (str,), # noqa: E501 + '_from': (str,), # noqa: E501 + 'to': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'granularity': 'granularity', # noqa: E501 + '_from': 'from', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, granularity, *args, **kwargs): # noqa: E501 + """DateRangeParameterValue - a model defined in OpenAPI + + Args: + granularity (str): Granularity of the period; determines the format of 'from' and 'to'. + + 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,) + _from (str): Start of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the start.. [optional] # noqa: E501 + to (str): End of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the end.. [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.granularity = granularity + 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, granularity, *args, **kwargs): # noqa: E501 + """DateRangeParameterValue - a model defined in OpenAPI + + Args: + granularity (str): Granularity of the period; determines the format of 'from' and 'to'. + + 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,) + _from (str): Start of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the start.. [optional] # noqa: E501 + to (str): End of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the end.. [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.granularity = granularity + 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_analytics_layer.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py index 53ecf55a0..6ef2e34da 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py @@ -40,6 +40,7 @@ def lazy_import(): from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext from gooddata_api_client.model.declarative_memory_item import DeclarativeMemoryItem from gooddata_api_client.model.declarative_metric import DeclarativeMetric + from gooddata_api_client.model.declarative_metric_extension import DeclarativeMetricExtension from gooddata_api_client.model.declarative_parameter import DeclarativeParameter from gooddata_api_client.model.declarative_publisher_document import DeclarativePublisherDocument from gooddata_api_client.model.declarative_publisher_document_page_template import DeclarativePublisherDocumentPageTemplate @@ -48,6 +49,7 @@ def lazy_import(): from gooddata_api_client.model.declarative_report_page_layout import DeclarativeReportPageLayout from gooddata_api_client.model.declarative_report_template import DeclarativeReportTemplate from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject + from gooddata_api_client.model.declarative_visualization_object_extension import DeclarativeVisualizationObjectExtension globals()['DeclarativeAnalyticalDashboard'] = DeclarativeAnalyticalDashboard globals()['DeclarativeAnalyticalDashboardExtension'] = DeclarativeAnalyticalDashboardExtension globals()['DeclarativeAttributeHierarchy'] = DeclarativeAttributeHierarchy @@ -57,6 +59,7 @@ def lazy_import(): globals()['DeclarativeFilterContext'] = DeclarativeFilterContext globals()['DeclarativeMemoryItem'] = DeclarativeMemoryItem globals()['DeclarativeMetric'] = DeclarativeMetric + globals()['DeclarativeMetricExtension'] = DeclarativeMetricExtension globals()['DeclarativeParameter'] = DeclarativeParameter globals()['DeclarativePublisherDocument'] = DeclarativePublisherDocument globals()['DeclarativePublisherDocumentPageTemplate'] = DeclarativePublisherDocumentPageTemplate @@ -65,6 +68,7 @@ def lazy_import(): globals()['DeclarativeReportPageLayout'] = DeclarativeReportPageLayout globals()['DeclarativeReportTemplate'] = DeclarativeReportTemplate globals()['DeclarativeVisualizationObject'] = DeclarativeVisualizationObject + globals()['DeclarativeVisualizationObjectExtension'] = DeclarativeVisualizationObjectExtension class DeclarativeAnalyticsLayer(ModelNormal): @@ -130,12 +134,14 @@ def openapi_types(): 'export_definitions': ([DeclarativeExportDefinition],), # noqa: E501 'filter_contexts': ([DeclarativeFilterContext],), # noqa: E501 'memory_items': ([DeclarativeMemoryItem],), # noqa: E501 + 'metric_extensions': ([DeclarativeMetricExtension],), # noqa: E501 'metrics': ([DeclarativeMetric],), # noqa: E501 'page_templates': ([DeclarativePublisherDocumentPageTemplate],), # noqa: E501 'parameters': ([DeclarativeParameter],), # noqa: E501 'report_page_layouts': ([DeclarativeReportPageLayout],), # noqa: E501 'report_templates': ([DeclarativeReportTemplate],), # noqa: E501 'reports': ([DeclarativeReport],), # noqa: E501 + 'visualization_object_extensions': ([DeclarativeVisualizationObjectExtension],), # noqa: E501 'visualization_objects': ([DeclarativeVisualizationObject],), # noqa: E501 } @@ -155,12 +161,14 @@ def discriminator(): 'export_definitions': 'exportDefinitions', # noqa: E501 'filter_contexts': 'filterContexts', # noqa: E501 'memory_items': 'memoryItems', # noqa: E501 + 'metric_extensions': 'metricExtensions', # noqa: E501 'metrics': 'metrics', # noqa: E501 'page_templates': 'pageTemplates', # noqa: E501 'parameters': 'parameters', # noqa: E501 'report_page_layouts': 'reportPageLayouts', # noqa: E501 'report_templates': 'reportTemplates', # noqa: E501 'reports': 'reports', # noqa: E501 + 'visualization_object_extensions': 'visualizationObjectExtensions', # noqa: E501 'visualization_objects': 'visualizationObjects', # noqa: E501 } @@ -215,12 +223,14 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 memory_items ([DeclarativeMemoryItem]): A list of AI memory items available in the workspace.. [optional] # noqa: E501 + metric_extensions ([DeclarativeMetricExtension]): A list of metric permissions assigned to a related metric.. [optional] # noqa: E501 metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 page_templates ([DeclarativePublisherDocumentPageTemplate]): A list of page templates available in the model.. [optional] # noqa: E501 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 reports ([DeclarativeReport]): A list of reports available in the model.. [optional] # noqa: E501 + visualization_object_extensions ([DeclarativeVisualizationObjectExtension]): A list of visualization object permissions assigned to a related visualization object.. [optional] # noqa: E501 visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 """ @@ -317,12 +327,14 @@ def __init__(self, *args, **kwargs): # noqa: E501 export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 memory_items ([DeclarativeMemoryItem]): A list of AI memory items available in the workspace.. [optional] # noqa: E501 + metric_extensions ([DeclarativeMetricExtension]): A list of metric permissions assigned to a related metric.. [optional] # noqa: E501 metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 page_templates ([DeclarativePublisherDocumentPageTemplate]): A list of page templates available in the model.. [optional] # noqa: E501 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 reports ([DeclarativeReport]): A list of reports available in the model.. [optional] # noqa: E501 + visualization_object_extensions ([DeclarativeVisualizationObjectExtension]): A list of visualization object permissions assigned to a related visualization object.. [optional] # noqa: E501 visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric_extension.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_extension.py new file mode 100644 index 000000000..bf09b4b6d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_extension.py @@ -0,0 +1,287 @@ +""" + 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_metric_permissions_inner import DeclarativeMetricPermissionsInner + globals()['DeclarativeMetricPermissionsInner'] = DeclarativeMetricPermissionsInner + + +class DeclarativeMetricExtension(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 + }, + }, + } + + @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 + 'permissions': ([DeclarativeMetricPermissionsInner],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, permissions, *args, **kwargs): # noqa: E501 + """DeclarativeMetricExtension - a model defined in OpenAPI + + Args: + id (str): Metric ID. + permissions ([DeclarativeMetricPermissionsInner]): A list of permissions. + + 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.id = id + self.permissions = permissions + 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, permissions, *args, **kwargs): # noqa: E501 + """DeclarativeMetricExtension - a model defined in OpenAPI + + Args: + id (str): Metric ID. + permissions ([DeclarativeMetricPermissionsInner]): A list of permissions. + + 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.id = id + self.permissions = permissions + 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_metric_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_assignment.py index 0dfc036d8..b5ce1c0b3 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_assignment.py @@ -74,7 +74,7 @@ def additional_properties_type(): """ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = True + _nullable = False @cached_property def openapi_types(): diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py index 39ec27214..659f3d24f 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py @@ -31,7 +31,9 @@ def lazy_import(): + from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier from gooddata_api_client.model.publisher_document_page_template_content import PublisherDocumentPageTemplateContent + globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier globals()['PublisherDocumentPageTemplateContent'] = PublisherDocumentPageTemplateContent @@ -71,9 +73,19 @@ class DeclarativePublisherDocumentPageTemplate(ModelNormal): ('title',): { 'max_length': 255, }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('tags',): { }, } @@ -105,7 +117,11 @@ def openapi_types(): 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 'version': (str,), # noqa: E501 + 'created_at': (str, none_type,), # noqa: E501 + 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 + 'modified_at': (str, none_type,), # noqa: E501 + 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -119,7 +135,11 @@ def discriminator(): 'id': 'id', # noqa: E501 'title': 'title', # noqa: E501 'version': 'version', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 'description': 'description', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'modified_by': 'modifiedBy', # noqa: E501 'tags': 'tags', # noqa: E501 } @@ -170,7 +190,11 @@ def _from_openapi_data(cls, content, id, title, version, *args, **kwargs): # no Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Page template description.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 """ @@ -267,7 +291,11 @@ def __init__(self, content, id, title, version, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Page template description.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py index eb0082a2f..1df51c5c6 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py @@ -31,7 +31,9 @@ def lazy_import(): + from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier from gooddata_api_client.model.publisher_document_content import PublisherDocumentContent + globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier globals()['PublisherDocumentContent'] = PublisherDocumentContent @@ -71,9 +73,19 @@ class DeclarativePublisherDocumentTemplate(ModelNormal): ('title',): { 'max_length': 255, }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('tags',): { }, } @@ -105,7 +117,11 @@ def openapi_types(): 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 'version': (str,), # noqa: E501 + 'created_at': (str, none_type,), # noqa: E501 + 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 + 'modified_at': (str, none_type,), # noqa: E501 + 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -119,7 +135,11 @@ def discriminator(): 'id': 'id', # noqa: E501 'title': 'title', # noqa: E501 'version': 'version', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 'description': 'description', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'modified_by': 'modifiedBy', # noqa: E501 'tags': 'tags', # noqa: E501 } @@ -170,7 +190,11 @@ def _from_openapi_data(cls, content, id, title, version, *args, **kwargs): # no Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Document template description.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 """ @@ -267,7 +291,11 @@ def __init__(self, content, id, title, version, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Document template description.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 tags ([str]): [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 ff7f45c0d..44a5f9ef0 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -108,6 +108,8 @@ class DeclarativeSetting(ModelNormal): 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", + 'ENABLE_AI_TRACE_OBFUSCATION': "ENABLE_AI_TRACE_OBFUSCATION", + 'ENABLE_AI_PERSISTENCE_OBFUSCATION': "ENABLE_AI_PERSISTENCE_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -122,6 +124,8 @@ class DeclarativeSetting(ModelNormal): 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", 'QUERY_ENGINE': "QUERY_ENGINE", + 'EMBEDDING_ORIGINS': "EMBEDDING_ORIGINS", + 'AI_LAKE_CREDENTIAL_VENDING': "AI_LAKE_CREDENTIAL_VENDING", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_extension.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_extension.py new file mode 100644 index 000000000..09a1d684a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_extension.py @@ -0,0 +1,287 @@ +""" + 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_visualization_object_permissions_inner import DeclarativeVisualizationObjectPermissionsInner + globals()['DeclarativeVisualizationObjectPermissionsInner'] = DeclarativeVisualizationObjectPermissionsInner + + +class DeclarativeVisualizationObjectExtension(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 + }, + }, + } + + @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 + 'permissions': ([DeclarativeVisualizationObjectPermissionsInner],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, permissions, *args, **kwargs): # noqa: E501 + """DeclarativeVisualizationObjectExtension - a model defined in OpenAPI + + Args: + id (str): Visualization object ID. + permissions ([DeclarativeVisualizationObjectPermissionsInner]): A list of permissions. + + 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.id = id + self.permissions = permissions + 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, permissions, *args, **kwargs): # noqa: E501 + """DeclarativeVisualizationObjectExtension - a model defined in OpenAPI + + Args: + id (str): Visualization object ID. + permissions ([DeclarativeVisualizationObjectPermissionsInner]): A list of permissions. + + 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.id = id + self.permissions = permissions + 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_visualization_object_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_assignment.py index ed9357113..505abb089 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_assignment.py @@ -74,7 +74,7 @@ def additional_properties_type(): """ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = True + _nullable = False @cached_property def openapi_types(): diff --git a/gooddata-api-client/gooddata_api_client/model/failed_operation.py b/gooddata-api-client/gooddata_api_client/model/failed_operation.py index aa90bd9df..bcce775f4 100644 --- a/gooddata-api-client/gooddata_api_client/model/failed_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/failed_operation.py @@ -72,6 +72,7 @@ class FailedOperation(ModelComposed): 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", 'ANALYZE-STATISTICS': "analyze-statistics", + 'REFRESH-DATA-SOURCE': "refresh-data-source", }, } @@ -134,7 +135,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 status (str): defaults to "failed", must be one of ["failed", ] # noqa: E501 error (OperationError): id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. @@ -242,7 +243,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 status (str): defaults to "failed", must be one of ["failed", ] # noqa: E501 error (OperationError): id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition.py b/gooddata-api-client/gooddata_api_client/model/filter_definition.py index 763e05e17..31a06cc48 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition.py @@ -47,6 +47,8 @@ def lazy_import(): from gooddata_api_client.model.match_attribute_filter_match_attribute_filter import MatchAttributeFilterMatchAttributeFilter from gooddata_api_client.model.negative_attribute_filter import NegativeAttributeFilter from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter + from gooddata_api_client.model.parameterized_date_filter import ParameterizedDateFilter + from gooddata_api_client.model.parameterized_date_filter_parameterized_date_filter import ParameterizedDateFilterParameterizedDateFilter from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter from gooddata_api_client.model.range_measure_value_filter import RangeMeasureValueFilter @@ -71,6 +73,8 @@ def lazy_import(): globals()['MatchAttributeFilterMatchAttributeFilter'] = MatchAttributeFilterMatchAttributeFilter globals()['NegativeAttributeFilter'] = NegativeAttributeFilter globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter + globals()['ParameterizedDateFilter'] = ParameterizedDateFilter + globals()['ParameterizedDateFilterParameterizedDateFilter'] = ParameterizedDateFilterParameterizedDateFilter globals()['PositiveAttributeFilter'] = PositiveAttributeFilter globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter globals()['RangeMeasureValueFilter'] = RangeMeasureValueFilter @@ -141,6 +145,7 @@ def openapi_types(): 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 + 'parameterized_date_filter': (ParameterizedDateFilterParameterizedDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 @@ -161,6 +166,7 @@ def discriminator(): 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 + 'parameterized_date_filter': 'parameterizedDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 @@ -214,6 +220,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 @@ -329,6 +336,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 @@ -413,6 +421,7 @@ def _composed_schemas(): InlineFilterDefinition, MatchAttributeFilter, NegativeAttributeFilter, + ParameterizedDateFilter, PositiveAttributeFilter, RangeMeasureValueFilter, RankingFilter, diff --git a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py index 01e6c28ff..ab394d9c7 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition_for_simple_measure.py @@ -38,6 +38,7 @@ def lazy_import(): from gooddata_api_client.model.date_filter import DateFilter from gooddata_api_client.model.match_attribute_filter_match_attribute_filter import MatchAttributeFilterMatchAttributeFilter from gooddata_api_client.model.negative_attribute_filter_negative_attribute_filter import NegativeAttributeFilterNegativeAttributeFilter + from gooddata_api_client.model.parameterized_date_filter_parameterized_date_filter import ParameterizedDateFilterParameterizedDateFilter from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter @@ -47,6 +48,7 @@ def lazy_import(): globals()['DateFilter'] = DateFilter globals()['MatchAttributeFilterMatchAttributeFilter'] = MatchAttributeFilterMatchAttributeFilter globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter + globals()['ParameterizedDateFilterParameterizedDateFilter'] = ParameterizedDateFilterParameterizedDateFilter globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter @@ -106,6 +108,7 @@ def openapi_types(): return { 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 + 'parameterized_date_filter': (ParameterizedDateFilterParameterizedDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 @@ -121,6 +124,7 @@ def discriminator(): attribute_map = { 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 + 'parameterized_date_filter': 'parameterizedDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 @@ -169,6 +173,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 @@ -279,6 +284,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py b/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py index 1a84a2f41..0a5a4c688 100644 --- a/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py +++ b/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py @@ -71,6 +71,7 @@ class GetAiLakeOperation200Response(ModelComposed): 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", 'ANALYZE-STATISTICS': "analyze-statistics", + 'REFRESH-DATA-SOURCE': "refresh-data-source", }, } @@ -172,7 +173,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) result ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Operation-specific result payload, can be missing for operations like delete. [optional] # noqa: E501 id (str): Id of the operation. [optional] # noqa: E501 - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. . [optional] # noqa: E501 + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ @@ -280,7 +281,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) result ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Operation-specific result payload, can be missing for operations like delete. [optional] # noqa: E501 id (str): Id of the operation. [optional] # noqa: E501 - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. . [optional] # noqa: E501 + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/good_data_ai_provider_config.py b/gooddata-api-client/gooddata_api_client/model/good_data_ai_provider_config.py new file mode 100644 index 000000000..7f69b5c35 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/good_data_ai_provider_config.py @@ -0,0 +1,275 @@ +""" + 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 GoodDataAiProviderConfig(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',): { + 'GOODDATA_AI': "GOODDATA_AI", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GoodDataAiProviderConfig - a model defined in OpenAPI + + Args: + + Keyword Args: + type (str): Provider type.. defaults to "GOODDATA_AI", must be one of ["GOODDATA_AI", ] # 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', "GOODDATA_AI") + _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.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, *args, **kwargs): # noqa: E501 + """GoodDataAiProviderConfig - a model defined in OpenAPI + + Args: + + Keyword Args: + type (str): Provider type.. defaults to "GOODDATA_AI", must be one of ["GOODDATA_AI", ] # 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', "GOODDATA_AI") + _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.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/json_api_llm_provider_in_attributes_provider_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py index ceee21e89..20474c18f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_in_attributes_provider_config.py @@ -35,11 +35,13 @@ def lazy_import(): from gooddata_api_client.model.anthropic_provider_config import AnthropicProviderConfig from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig + from gooddata_api_client.model.good_data_ai_provider_config import GoodDataAiProviderConfig from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig globals()['AnthropicProviderAuth'] = AnthropicProviderAuth globals()['AnthropicProviderConfig'] = AnthropicProviderConfig globals()['AwsBedrockProviderConfig'] = AwsBedrockProviderConfig globals()['AzureFoundryProviderConfig'] = AzureFoundryProviderConfig + globals()['GoodDataAiProviderConfig'] = GoodDataAiProviderConfig globals()['OpenAIProviderConfig'] = OpenAIProviderConfig @@ -69,7 +71,7 @@ class JsonApiLlmProviderInAttributesProviderConfig(ModelComposed): allowed_values = { ('type',): { - 'ANTHROPIC': "ANTHROPIC", + 'GOODDATA_AI': "GOODDATA_AI", }, } @@ -175,7 +177,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 base_url (str): Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.. [optional] if omitted the server will use the default value of "https://api.anthropic.com" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (AnthropicProviderAuth): [optional] # noqa: E501 - type (str): Provider type.. [optional] if omitted the server will use the default value of "ANTHROPIC" # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "GOODDATA_AI" # noqa: E501 endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 """ @@ -284,7 +286,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 base_url (str): Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.. [optional] if omitted the server will use the default value of "https://api.anthropic.com" # noqa: E501 organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 auth (AnthropicProviderAuth): [optional] # noqa: E501 - type (str): Provider type.. [optional] if omitted the server will use the default value of "ANTHROPIC" # noqa: E501 + type (str): Provider type.. [optional] if omitted the server will use the default value of "GOODDATA_AI" # noqa: E501 endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 region (str): AWS region for Bedrock.. [optional] # noqa: E501 """ @@ -361,6 +363,7 @@ def _composed_schemas(): AnthropicProviderConfig, AwsBedrockProviderConfig, AzureFoundryProviderConfig, + GoodDataAiProviderConfig, OpenAIProviderConfig, ], } 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 a02aa031f..60785987c 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 @@ -104,6 +104,8 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", + 'ENABLE_AI_TRACE_OBFUSCATION': "ENABLE_AI_TRACE_OBFUSCATION", + 'ENABLE_AI_PERSISTENCE_OBFUSCATION': "ENABLE_AI_PERSISTENCE_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -118,6 +120,8 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", 'QUERY_ENGINE': "QUERY_ENGINE", + 'EMBEDDING_ORIGINS': "EMBEDDING_ORIGINS", + 'AI_LAKE_CREDENTIAL_VENDING': "AI_LAKE_CREDENTIAL_VENDING", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_parameter_in_attributes_definition.py b/gooddata-api-client/gooddata_api_client/model/json_api_parameter_in_attributes_definition.py index bf9d9571d..a6d06764e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_parameter_in_attributes_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_parameter_in_attributes_definition.py @@ -31,9 +31,13 @@ def lazy_import(): + from gooddata_api_client.model.date_range_parameter_definition import DateRangeParameterDefinition + from gooddata_api_client.model.date_range_parameter_value import DateRangeParameterValue from gooddata_api_client.model.number_parameter_definition import NumberParameterDefinition from gooddata_api_client.model.string_constraints import StringConstraints from gooddata_api_client.model.string_parameter_definition import StringParameterDefinition + globals()['DateRangeParameterDefinition'] = DateRangeParameterDefinition + globals()['DateRangeParameterValue'] = DateRangeParameterValue globals()['NumberParameterDefinition'] = NumberParameterDefinition globals()['StringConstraints'] = StringConstraints globals()['StringParameterDefinition'] = StringParameterDefinition @@ -65,7 +69,7 @@ class JsonApiParameterInAttributesDefinition(ModelComposed): allowed_values = { ('type',): { - 'STRING': "STRING", + 'DATE_RANGE': "DATE_RANGE", }, } @@ -97,13 +101,15 @@ def openapi_types(): return { 'type': (str,), # noqa: E501 'constraints': (StringConstraints,), # noqa: E501 - 'default_value': (str,), # noqa: E501 + 'default_value': (DateRangeParameterValue,), # noqa: E501 } @cached_property def discriminator(): lazy_import() val = { + 'DATE_RANGE': DateRangeParameterDefinition, + 'DateRangeParameterDefinition': DateRangeParameterDefinition, 'NUMBER': NumberParameterDefinition, 'NumberParameterDefinition': NumberParameterDefinition, 'STRING': StringParameterDefinition, @@ -128,7 +134,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """JsonApiParameterInAttributesDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # noqa: E501 + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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. @@ -160,10 +166,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + default_value (DateRangeParameterValue): [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") + type = kwargs.get('type', "DATE_RANGE") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -235,7 +241,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 """JsonApiParameterInAttributesDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # noqa: E501 + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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. @@ -267,10 +273,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + default_value (DateRangeParameterValue): [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") + type = kwargs.get('type', "DATE_RANGE") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -340,6 +346,7 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ + DateRangeParameterDefinition, NumberParameterDefinition, StringParameterDefinition, ], diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py index 42844f607..26b5de6b9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py @@ -104,6 +104,8 @@ class JsonApiUserSettingInAttributes(ModelNormal): 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", + 'ENABLE_AI_TRACE_OBFUSCATION': "ENABLE_AI_TRACE_OBFUSCATION", + 'ENABLE_AI_PERSISTENCE_OBFUSCATION': "ENABLE_AI_PERSISTENCE_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py index 1599f0bb8..7c5a7ad52 100644 --- a/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/llm_provider_config.py @@ -34,11 +34,13 @@ def lazy_import(): from gooddata_api_client.model.anthropic_provider_config import AnthropicProviderConfig from gooddata_api_client.model.aws_bedrock_provider_config import AwsBedrockProviderConfig from gooddata_api_client.model.azure_foundry_provider_config import AzureFoundryProviderConfig + from gooddata_api_client.model.good_data_ai_provider_config import GoodDataAiProviderConfig from gooddata_api_client.model.open_ai_provider_auth import OpenAiProviderAuth from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig globals()['AnthropicProviderConfig'] = AnthropicProviderConfig globals()['AwsBedrockProviderConfig'] = AwsBedrockProviderConfig globals()['AzureFoundryProviderConfig'] = AzureFoundryProviderConfig + globals()['GoodDataAiProviderConfig'] = GoodDataAiProviderConfig globals()['OpenAIProviderConfig'] = OpenAIProviderConfig globals()['OpenAiProviderAuth'] = OpenAiProviderAuth @@ -361,6 +363,7 @@ def _composed_schemas(): AnthropicProviderConfig, AwsBedrockProviderConfig, AzureFoundryProviderConfig, + GoodDataAiProviderConfig, OpenAIProviderConfig, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/localization_issue.py b/gooddata-api-client/gooddata_api_client/model/localization_issue.py new file mode 100644 index 000000000..cbe965928 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_issue.py @@ -0,0 +1,285 @@ +""" + 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 LocalizationIssue(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',): { + 'MISSING_TRANSLATION': "METADATA_MISSING_TRANSLATION", + 'LANGUAGE_MISMATCH': "METADATA_LANGUAGE_MISMATCH", + 'UNUSED_TRANSLATION': "METADATA_UNUSED_TRANSLATION", + }, + } + + 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 { + 'locale': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'workspaces': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'locale': 'locale', # noqa: E501 + 'type': 'type', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, locale, type, *args, **kwargs): # noqa: E501 + """LocalizationIssue - a model defined in OpenAPI + + Args: + locale (str): The problem language. + type (str): The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added. + + 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,) + workspaces (int): Organization issues only. The number of workspaces with this issue.. [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.locale = locale + 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, locale, type, *args, **kwargs): # noqa: E501 + """LocalizationIssue - a model defined in OpenAPI + + Args: + locale (str): The problem language. + type (str): The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added. + + 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,) + workspaces (int): Organization issues only. The number of workspaces with this issue.. [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.locale = locale + 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/localization_issue_workspace.py b/gooddata-api-client/gooddata_api_client/model/localization_issue_workspace.py new file mode 100644 index 000000000..a38f2a294 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_issue_workspace.py @@ -0,0 +1,298 @@ +""" + 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.localization_resolved_values import LocalizationResolvedValues + globals()['LocalizationResolvedValues'] = LocalizationResolvedValues + + +class LocalizationIssueWorkspace(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 { + 'by_setting': (LocalizationResolvedValues,), # noqa: E501 + 'children_count': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'parent_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by_setting': 'bySetting', # noqa: E501 + 'children_count': 'childrenCount', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'parent_id': 'parentId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, by_setting, children_count, id, name, *args, **kwargs): # noqa: E501 + """LocalizationIssueWorkspace - a model defined in OpenAPI + + Args: + by_setting (LocalizationResolvedValues): + children_count (int): Number of direct child workspaces. + id (str): + name (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,) + parent_id (str, none_type): The parent workspace, or null for a root workspace.. [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.by_setting = by_setting + self.children_count = children_count + self.id = id + 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, by_setting, children_count, id, name, *args, **kwargs): # noqa: E501 + """LocalizationIssueWorkspace - a model defined in OpenAPI + + Args: + by_setting (LocalizationResolvedValues): + children_count (int): Number of direct child workspaces. + id (str): + name (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,) + parent_id (str, none_type): The parent workspace, or null for a root workspace.. [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.by_setting = by_setting + self.children_count = children_count + self.id = id + 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/localization_issue_workspaces.py b/gooddata-api-client/gooddata_api_client/model/localization_issue_workspaces.py new file mode 100644 index 000000000..d8e50efcc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_issue_workspaces.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.localization_issue_workspace import LocalizationIssueWorkspace + globals()['LocalizationIssueWorkspace'] = LocalizationIssueWorkspace + + +class LocalizationIssueWorkspaces(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 { + 'total_count': (int,), # noqa: E501 + 'workspaces': ([LocalizationIssueWorkspace],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_count': 'totalCount', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total_count, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationIssueWorkspaces - a model defined in OpenAPI + + Args: + total_count (int): The total number of workspaces with this issue that match the name filter. + workspaces ([LocalizationIssueWorkspace]): + + 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.total_count = total_count + self.workspaces = workspaces + 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, total_count, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationIssueWorkspaces - a model defined in OpenAPI + + Args: + total_count (int): The total number of workspaces with this issue that match the name filter. + workspaces ([LocalizationIssueWorkspace]): + + 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.total_count = total_count + self.workspaces = workspaces + 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/localization_issues.py b/gooddata-api-client/gooddata_api_client/model/localization_issues.py new file mode 100644 index 000000000..e7ba8e124 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_issues.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.localization_issue import LocalizationIssue + globals()['LocalizationIssue'] = LocalizationIssue + + +class LocalizationIssues(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 { + 'issues': ([LocalizationIssue],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'issues': 'issues', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, issues, *args, **kwargs): # noqa: E501 + """LocalizationIssues - a model defined in OpenAPI + + Args: + issues ([LocalizationIssue]): Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong. + + 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.issues = issues + 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, issues, *args, **kwargs): # noqa: E501 + """LocalizationIssues - a model defined in OpenAPI + + Args: + issues ([LocalizationIssue]): Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong. + + 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.issues = issues + 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/localization_metadata_statistics.py b/gooddata-api-client/gooddata_api_client/model/localization_metadata_statistics.py index ae3abf24f..77504f99b 100644 --- a/gooddata-api-client/gooddata_api_client/model/localization_metadata_statistics.py +++ b/gooddata-api-client/gooddata_api_client/model/localization_metadata_statistics.py @@ -32,7 +32,9 @@ def lazy_import(): from gooddata_api_client.model.localization_statistics_locale import LocalizationStatisticsLocale + from gooddata_api_client.model.localization_statistics_workspace import LocalizationStatisticsWorkspace globals()['LocalizationStatisticsLocale'] = LocalizationStatisticsLocale + globals()['LocalizationStatisticsWorkspace'] = LocalizationStatisticsWorkspace class LocalizationMetadataStatistics(ModelNormal): @@ -89,6 +91,7 @@ def openapi_types(): lazy_import() return { 'locales': ([LocalizationStatisticsLocale],), # noqa: E501 + 'workspaces': ([LocalizationStatisticsWorkspace],), # noqa: E501 } @cached_property @@ -98,6 +101,7 @@ def discriminator(): attribute_map = { 'locales': 'locales', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 } read_only_vars = { @@ -144,6 +148,7 @@ def _from_openapi_data(cls, locales, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + workspaces ([LocalizationStatisticsWorkspace]): (BETA) Translation counts of the workspace and each parent workspace that the user can see, root first. Present only with `includeCoverage=true` on the workspace endpoint.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -233,6 +238,7 @@ def __init__(self, locales, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + workspaces ([LocalizationStatisticsWorkspace]): (BETA) Translation counts of the workspace and each parent workspace that the user can see, root first. Present only with `includeCoverage=true` on the workspace endpoint.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py b/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py index ead1bc6e2..f8d9fb4ab 100644 --- a/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py +++ b/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py @@ -90,6 +90,7 @@ def openapi_types(): return { 'users': (LocalizationCount,), # noqa: E501 'workspaces': (LocalizationCount,), # noqa: E501 + 'child_workspaces': (LocalizationCount,), # noqa: E501 } @cached_property @@ -100,6 +101,7 @@ def discriminator(): attribute_map = { 'users': 'users', # noqa: E501 'workspaces': 'workspaces', # noqa: E501 + 'child_workspaces': 'childWorkspaces', # noqa: E501 } read_only_vars = { @@ -147,6 +149,7 @@ def _from_openapi_data(cls, users, workspaces, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + child_workspaces (LocalizationCount): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -238,6 +241,7 @@ def __init__(self, users, workspaces, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + child_workspaces (LocalizationCount): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/localization_statistics_translated_locale.py b/gooddata-api-client/gooddata_api_client/model/localization_statistics_translated_locale.py new file mode 100644 index 000000000..75a390db8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_statistics_translated_locale.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 + + + +class LocalizationStatisticsTranslatedLocale(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 + """ + 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 { + 'locale': (str,), # noqa: E501 + 'translated': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'locale': 'locale', # noqa: E501 + 'translated': 'translated', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, locale, translated, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsTranslatedLocale - a model defined in OpenAPI + + Args: + locale (str): Language tag. + translated (int): Texts of the workspace with a translation. A title, description or tag edited after its translation still counts. + + 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.locale = locale + self.translated = translated + 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, locale, translated, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsTranslatedLocale - a model defined in OpenAPI + + Args: + locale (str): Language tag. + translated (int): Texts of the workspace with a translation. A title, description or tag edited after its translation still counts. + + 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.locale = locale + self.translated = translated + 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/localization_statistics_workspace.py b/gooddata-api-client/gooddata_api_client/model/localization_statistics_workspace.py new file mode 100644 index 000000000..018334781 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_statistics_workspace.py @@ -0,0 +1,298 @@ +""" + 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.localization_statistics_translated_locale import LocalizationStatisticsTranslatedLocale + globals()['LocalizationStatisticsTranslatedLocale'] = LocalizationStatisticsTranslatedLocale + + +class LocalizationStatisticsWorkspace(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 { + 'id': (str,), # noqa: E501 + 'locales': ([LocalizationStatisticsTranslatedLocale],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'total': (int,), # noqa: E501 + 'parent_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'locales': 'locales', # noqa: E501 + 'name': 'name', # noqa: E501 + 'total': 'total', # noqa: E501 + 'parent_id': 'parentId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, locales, name, total, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsWorkspace - a model defined in OpenAPI + + Args: + id (str): Workspace ID. + locales ([LocalizationStatisticsTranslatedLocale]): Every language of `metadata.locales`, sorted, with 0 where nothing is translated. + name (str): Workspace name. + total (int): Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted. + + 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,) + parent_id (str, none_type): Parent workspace ID, null for a root workspace.. [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.locales = locales + self.name = name + self.total = total + 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, locales, name, total, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsWorkspace - a model defined in OpenAPI + + Args: + id (str): Workspace ID. + locales ([LocalizationStatisticsTranslatedLocale]): Every language of `metadata.locales`, sorted, with 0 where nothing is translated. + name (str): Workspace name. + total (int): Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted. + + 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,) + parent_id (str, none_type): Parent workspace ID, null for a root workspace.. [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.locales = locales + self.name = name + self.total = total + 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/localization_usage_value.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_value.py index 168293d1d..8414b4e4f 100644 --- a/gooddata-api-client/gooddata_api_client/model/localization_usage_value.py +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_value.py @@ -96,6 +96,7 @@ def openapi_types(): 'content': (LocalizationContent,), # noqa: E501 'users': (LocalizationCount,), # noqa: E501 'workspaces': (LocalizationCount,), # noqa: E501 + 'child_workspaces': (LocalizationCount,), # noqa: E501 } @cached_property @@ -108,6 +109,7 @@ def discriminator(): 'content': 'content', # noqa: E501 'users': 'users', # noqa: E501 'workspaces': 'workspaces', # noqa: E501 + 'child_workspaces': 'childWorkspaces', # noqa: E501 } read_only_vars = { @@ -157,6 +159,7 @@ def _from_openapi_data(cls, by_setting, content, users, workspaces, *args, **kwa Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + child_workspaces (LocalizationCount): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -252,6 +255,7 @@ def __init__(self, by_setting, content, users, workspaces, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + child_workspaces (LocalizationCount): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/operation.py b/gooddata-api-client/gooddata_api_client/model/operation.py index 5298a7261..8b8044000 100644 --- a/gooddata-api-client/gooddata_api_client/model/operation.py +++ b/gooddata-api-client/gooddata_api_client/model/operation.py @@ -69,6 +69,7 @@ class Operation(ModelNormal): 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", 'ANALYZE-STATISTICS': "analyze-statistics", + 'REFRESH-DATA-SOURCE': "refresh-data-source", }, } @@ -133,7 +134,7 @@ def _from_openapi_data(cls, id, kind, status, *args, **kwargs): # noqa: E501 Args: id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. status (str): Keyword Args: @@ -226,7 +227,7 @@ def __init__(self, id, kind, status, *args, **kwargs): # noqa: E501 Args: id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. status (str): Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/parameter_definition.py b/gooddata-api-client/gooddata_api_client/model/parameter_definition.py index a376aa2bc..23b2a4b2d 100644 --- a/gooddata-api-client/gooddata_api_client/model/parameter_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/parameter_definition.py @@ -31,9 +31,13 @@ def lazy_import(): + from gooddata_api_client.model.date_range_parameter_definition import DateRangeParameterDefinition + from gooddata_api_client.model.date_range_parameter_value import DateRangeParameterValue from gooddata_api_client.model.number_parameter_definition import NumberParameterDefinition from gooddata_api_client.model.string_constraints import StringConstraints from gooddata_api_client.model.string_parameter_definition import StringParameterDefinition + globals()['DateRangeParameterDefinition'] = DateRangeParameterDefinition + globals()['DateRangeParameterValue'] = DateRangeParameterValue globals()['NumberParameterDefinition'] = NumberParameterDefinition globals()['StringConstraints'] = StringConstraints globals()['StringParameterDefinition'] = StringParameterDefinition @@ -65,7 +69,7 @@ class ParameterDefinition(ModelComposed): allowed_values = { ('type',): { - 'STRING': "STRING", + 'DATE_RANGE': "DATE_RANGE", }, } @@ -97,13 +101,15 @@ def openapi_types(): return { 'type': (str,), # noqa: E501 'constraints': (StringConstraints,), # noqa: E501 - 'default_value': (str,), # noqa: E501 + 'default_value': (DateRangeParameterValue,), # noqa: E501 } @cached_property def discriminator(): lazy_import() val = { + 'DATE_RANGE': DateRangeParameterDefinition, + 'DateRangeParameterDefinition': DateRangeParameterDefinition, 'NUMBER': NumberParameterDefinition, 'NumberParameterDefinition': NumberParameterDefinition, 'STRING': StringParameterDefinition, @@ -128,7 +134,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """ParameterDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # noqa: E501 + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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. @@ -160,10 +166,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + default_value (DateRangeParameterValue): [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") + type = kwargs.get('type', "DATE_RANGE") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -235,7 +241,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 """ParameterDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # noqa: E501 + type (str): The parameter type.. defaults to "DATE_RANGE", must be one of ["DATE_RANGE", ] # 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. @@ -267,10 +273,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + default_value (DateRangeParameterValue): [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") + type = kwargs.get('type', "DATE_RANGE") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -340,6 +346,7 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ + DateRangeParameterDefinition, NumberParameterDefinition, StringParameterDefinition, ], diff --git a/gooddata-api-client/gooddata_api_client/model/parameterized_date_filter.py b/gooddata-api-client/gooddata_api_client/model/parameterized_date_filter.py new file mode 100644 index 000000000..3aa0cc262 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/parameterized_date_filter.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.parameterized_date_filter_parameterized_date_filter import ParameterizedDateFilterParameterizedDateFilter + globals()['ParameterizedDateFilterParameterizedDateFilter'] = ParameterizedDateFilterParameterizedDateFilter + + +class ParameterizedDateFilter(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 { + 'parameterized_date_filter': (ParameterizedDateFilterParameterizedDateFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parameterized_date_filter': 'parameterizedDateFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, parameterized_date_filter, *args, **kwargs): # noqa: E501 + """ParameterizedDateFilter - a model defined in OpenAPI + + Args: + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): + + 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.parameterized_date_filter = parameterized_date_filter + 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, parameterized_date_filter, *args, **kwargs): # noqa: E501 + """ParameterizedDateFilter - a model defined in OpenAPI + + Args: + parameterized_date_filter (ParameterizedDateFilterParameterizedDateFilter): + + 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.parameterized_date_filter = parameterized_date_filter + 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/parameterized_date_filter_parameterized_date_filter.py b/gooddata-api-client/gooddata_api_client/model/parameterized_date_filter_parameterized_date_filter.py new file mode 100644 index 000000000..df250c766 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/parameterized_date_filter_parameterized_date_filter.py @@ -0,0 +1,301 @@ +""" + 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.afm_object_identifier_dataset import AfmObjectIdentifierDataset + from gooddata_api_client.model.afm_object_identifier_parameter import AfmObjectIdentifierParameter + globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset + globals()['AfmObjectIdentifierParameter'] = AfmObjectIdentifierParameter + + +class ParameterizedDateFilterParameterizedDateFilter(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 = { + ('empty_value_handling',): { + 'INCLUDE': "INCLUDE", + 'EXCLUDE': "EXCLUDE", + 'ONLY': "ONLY", + }, + } + + 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 { + 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 + 'parameter': (AfmObjectIdentifierParameter,), # noqa: E501 + 'apply_on_result': (bool,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dataset': 'dataset', # noqa: E501 + 'parameter': 'parameter', # noqa: E501 + 'apply_on_result': 'applyOnResult', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, dataset, parameter, *args, **kwargs): # noqa: E501 + """ParameterizedDateFilterParameterizedDateFilter - a model defined in OpenAPI + + Args: + dataset (AfmObjectIdentifierDataset): + parameter (AfmObjectIdentifierParameter): + + 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,) + apply_on_result (bool): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 + local_identifier (str): [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.dataset = dataset + self.parameter = parameter + 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, dataset, parameter, *args, **kwargs): # noqa: E501 + """ParameterizedDateFilterParameterizedDateFilter - a model defined in OpenAPI + + Args: + dataset (AfmObjectIdentifierDataset): + parameter (AfmObjectIdentifierParameter): + + 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,) + apply_on_result (bool): [optional] # noqa: E501 + empty_value_handling (str): Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.. [optional] if omitted the server will use the default value of "EXCLUDE" # noqa: E501 + local_identifier (str): [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.dataset = dataset + self.parameter = parameter + 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/pending_operation.py b/gooddata-api-client/gooddata_api_client/model/pending_operation.py index 916b8db83..194ea53f2 100644 --- a/gooddata-api-client/gooddata_api_client/model/pending_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/pending_operation.py @@ -68,6 +68,7 @@ class PendingOperation(ModelComposed): 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", 'ANALYZE-STATISTICS': "analyze-statistics", + 'REFRESH-DATA-SOURCE': "refresh-data-source", }, } @@ -127,7 +128,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "pending", must be one of ["pending", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. @@ -234,7 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "pending", must be one of ["pending", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py index 4ad069de6..6d34eeb32 100644 --- a/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py @@ -147,7 +147,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) style (PublisherDocumentTextStyle): [optional] # noqa: E501 text (str): Overrides the default title; may contain text variables.. [optional] # noqa: E501 - visible (bool): Default `true`.. [optional] # noqa: E501 + visible (bool): When left out, a visualization's title is hidden and a takeaway's is shown.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -235,7 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) style (PublisherDocumentTextStyle): [optional] # noqa: E501 text (str): Overrides the default title; may contain text variables.. [optional] # noqa: E501 - visible (bool): Default `true`.. [optional] # noqa: E501 + visible (bool): When left out, a visualization's title is hidden and a takeaway's is shown.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py index d4a7f942c..df2dabd75 100644 --- a/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/relative_bounded_date_filter.py @@ -132,8 +132,8 @@ def openapi_types(): """ return { 'granularity': (str,), # noqa: E501 - '_from': (int,), # noqa: E501 - 'to': (int,), # noqa: E501 + '_from': (int, none_type,), # noqa: E501 + 'to': (int, none_type,), # noqa: E501 } @cached_property @@ -191,8 +191,8 @@ def _from_openapi_data(cls, granularity, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 + _from (int, none_type): [optional] # noqa: E501 + to (int, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -282,8 +282,8 @@ def __init__(self, granularity, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 + _from (int, none_type): [optional] # noqa: E501 + to (int, none_type): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) 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 3e8a57ffa..0d9078636 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -108,6 +108,8 @@ class ResolvedSetting(ModelNormal): 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", + 'ENABLE_AI_TRACE_OBFUSCATION': "ENABLE_AI_TRACE_OBFUSCATION", + 'ENABLE_AI_PERSISTENCE_OBFUSCATION': "ENABLE_AI_PERSISTENCE_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -122,6 +124,7 @@ class ResolvedSetting(ModelNormal): 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", 'QUERY_ENGINE': "QUERY_ENGINE", + 'AI_LAKE_CREDENTIAL_VENDING': "AI_LAKE_CREDENTIAL_VENDING", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py b/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py index dc26ed7f4..abd355897 100644 --- a/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py +++ b/gooddata-api-client/gooddata_api_client/model/result_cache_metadata.py @@ -32,9 +32,11 @@ def lazy_import(): from gooddata_api_client.model.afm import AFM + from gooddata_api_client.model.computation_profile import ComputationProfile from gooddata_api_client.model.execution_response import ExecutionResponse from gooddata_api_client.model.result_spec import ResultSpec globals()['AFM'] = AFM + globals()['ComputationProfile'] = ComputationProfile globals()['ExecutionResponse'] = ExecutionResponse globals()['ResultSpec'] = ResultSpec @@ -96,6 +98,7 @@ def openapi_types(): 'execution_response': (ExecutionResponse,), # noqa: E501 'result_size': (int,), # noqa: E501 'result_spec': (ResultSpec,), # noqa: E501 + 'computation_profile': (ComputationProfile,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'execution_response': 'executionResponse', # noqa: E501 'result_size': 'resultSize', # noqa: E501 'result_spec': 'resultSpec', # noqa: E501 + 'computation_profile': 'computationProfile', # noqa: E501 } read_only_vars = { @@ -157,6 +161,7 @@ def _from_openapi_data(cls, afm, execution_response, result_size, result_spec, * Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + computation_profile (ComputationProfile): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -252,6 +257,7 @@ def __init__(self, afm, execution_response, result_size, result_spec, *args, **k Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + computation_profile (ComputationProfile): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py index c23a75055..bf400a172 100644 --- a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py @@ -70,6 +70,7 @@ class SucceededOperation(ModelComposed): 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", 'ANALYZE-STATISTICS': "analyze-statistics", + 'REFRESH-DATA-SOURCE': "refresh-data-source", }, } @@ -131,7 +132,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "succeeded", must be one of ["succeeded", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. @@ -239,7 +240,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "succeeded", must be one of ["succeeded", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-data-source` — Refresh of an AI Lake data source after a data load. _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. diff --git a/gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_request.py b/gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_request.py new file mode 100644 index 000000000..a2203b453 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_request.py @@ -0,0 +1,270 @@ +""" + 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 ValidateEmbeddingOriginRequest(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 + """ + 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 { + 'origin': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'origin': 'origin', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, origin, *args, **kwargs): # noqa: E501 + """ValidateEmbeddingOriginRequest - a model defined in OpenAPI + + Args: + origin (str): The origin of the embedding application, or `*` when it hides its origin. + + 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.origin = origin + 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, origin, *args, **kwargs): # noqa: E501 + """ValidateEmbeddingOriginRequest - a model defined in OpenAPI + + Args: + origin (str): The origin of the embedding application, or `*` when it hides its origin. + + 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.origin = origin + 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/validate_embedding_origin_response.py b/gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_response.py new file mode 100644 index 000000000..3214d7c7c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validate_embedding_origin_response.py @@ -0,0 +1,270 @@ +""" + 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 ValidateEmbeddingOriginResponse(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 + """ + 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 { + 'valid': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'valid': 'valid', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, valid, *args, **kwargs): # noqa: E501 + """ValidateEmbeddingOriginResponse - a model defined in OpenAPI + + Args: + valid (bool): True when the embedding origins of the organization allow the origin. + + 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.valid = valid + 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, valid, *args, **kwargs): # noqa: E501 + """ValidateEmbeddingOriginResponse - a model defined in OpenAPI + + Args: + valid (bool): True when the embedding origins of the organization allow the origin. + + 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.valid = valid + 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 f330391f3..ef0b6287c 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -150,6 +150,8 @@ from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper from gooddata_api_client.model.compound_measure_value_filter import CompoundMeasureValueFilter from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter +from gooddata_api_client.model.computation_profile import ComputationProfile +from gooddata_api_client.model.computation_profile_source import ComputationProfileSource from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions from gooddata_api_client.model.computed_attribute_permissions_assignment import ComputedAttributePermissionsAssignment from gooddata_api_client.model.computed_attribute_permissions_for_assignee import ComputedAttributePermissionsForAssignee @@ -226,6 +228,8 @@ from gooddata_api_client.model.dataset_reference_identifier import DatasetReferenceIdentifier from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier from gooddata_api_client.model.date_filter import DateFilter +from gooddata_api_client.model.date_range_parameter_definition import DateRangeParameterDefinition +from gooddata_api_client.model.date_range_parameter_value import DateRangeParameterValue from gooddata_api_client.model.date_value import DateValue from gooddata_api_client.model.declarative_agent import DeclarativeAgent from gooddata_api_client.model.declarative_agents import DeclarativeAgents @@ -278,6 +282,7 @@ from gooddata_api_client.model.declarative_ldm import DeclarativeLdm from gooddata_api_client.model.declarative_memory_item import DeclarativeMemoryItem from gooddata_api_client.model.declarative_metric import DeclarativeMetric +from gooddata_api_client.model.declarative_metric_extension import DeclarativeMetricExtension from gooddata_api_client.model.declarative_metric_permission_assignment import DeclarativeMetricPermissionAssignment from gooddata_api_client.model.declarative_metric_permission_for_assignee import DeclarativeMetricPermissionForAssignee from gooddata_api_client.model.declarative_metric_permission_for_assignee_rule import DeclarativeMetricPermissionForAssigneeRule @@ -319,6 +324,7 @@ from gooddata_api_client.model.declarative_users import DeclarativeUsers from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.model.declarative_visualization_object_extension import DeclarativeVisualizationObjectExtension from gooddata_api_client.model.declarative_visualization_object_permission_assignment import DeclarativeVisualizationObjectPermissionAssignment from gooddata_api_client.model.declarative_visualization_object_permission_for_assignee import DeclarativeVisualizationObjectPermissionForAssignee from gooddata_api_client.model.declarative_visualization_object_permission_for_assignee_rule import DeclarativeVisualizationObjectPermissionForAssigneeRule @@ -422,6 +428,7 @@ from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse +from gooddata_api_client.model.good_data_ai_provider_config import GoodDataAiProviderConfig from gooddata_api_client.model.grain_identifier import GrainIdentifier from gooddata_api_client.model.granted_permission import GrantedPermission from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting @@ -1279,6 +1286,10 @@ from gooddata_api_client.model.localization_data_statistics import LocalizationDataStatistics from gooddata_api_client.model.localization_default import LocalizationDefault from gooddata_api_client.model.localization_defaults import LocalizationDefaults +from gooddata_api_client.model.localization_issue import LocalizationIssue +from gooddata_api_client.model.localization_issue_workspace import LocalizationIssueWorkspace +from gooddata_api_client.model.localization_issue_workspaces import LocalizationIssueWorkspaces +from gooddata_api_client.model.localization_issues import LocalizationIssues from gooddata_api_client.model.localization_metadata_statistics import LocalizationMetadataStatistics from gooddata_api_client.model.localization_resolved_value import LocalizationResolvedValue from gooddata_api_client.model.localization_resolved_values import LocalizationResolvedValues @@ -1287,6 +1298,8 @@ from gooddata_api_client.model.localization_source_counts import LocalizationSourceCounts from gooddata_api_client.model.localization_statistics import LocalizationStatistics from gooddata_api_client.model.localization_statistics_locale import LocalizationStatisticsLocale +from gooddata_api_client.model.localization_statistics_translated_locale import LocalizationStatisticsTranslatedLocale +from gooddata_api_client.model.localization_statistics_workspace import LocalizationStatisticsWorkspace from gooddata_api_client.model.localization_usage import LocalizationUsage from gooddata_api_client.model.localization_usage_user import LocalizationUsageUser from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers @@ -1366,6 +1379,8 @@ from gooddata_api_client.model.parameter_definition import ParameterDefinition from gooddata_api_client.model.parameter_item import ParameterItem from gooddata_api_client.model.parameter_value import ParameterValue +from gooddata_api_client.model.parameterized_date_filter import ParameterizedDateFilter +from gooddata_api_client.model.parameterized_date_filter_parameterized_date_filter import ParameterizedDateFilterParameterizedDateFilter from gooddata_api_client.model.pdf_table_style import PdfTableStyle from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest @@ -1589,6 +1604,8 @@ from gooddata_api_client.model.user_management_workspace_permission_assignment import UserManagementWorkspacePermissionAssignment from gooddata_api_client.model.user_permission import UserPermission from gooddata_api_client.model.validate_by_item import ValidateByItem +from gooddata_api_client.model.validate_embedding_origin_request import ValidateEmbeddingOriginRequest +from gooddata_api_client.model.validate_embedding_origin_response import ValidateEmbeddingOriginResponse from gooddata_api_client.model.validity_period_cache_retention import ValidityPeriodCacheRetention from gooddata_api_client.model.value import Value from gooddata_api_client.model.visible_filter import VisibleFilter diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py index 851b90d15..355c86770 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py @@ -504,7 +504,7 @@ def structure_period(v: dict[str, Any], _: Any) -> CatalogPublisherDocumentPerio @define(kw_only=True) -class CatalogDeclarativePublisherDocumentTemplate(CatalogAnalyticsObjectBase): +class CatalogDeclarativePublisherDocumentTemplate(CatalogAnalyticsBaseMeta): title: str content: dict[str, Any] version: str @@ -517,7 +517,7 @@ def client_class() -> type[DeclarativePublisherDocumentTemplate]: @define(kw_only=True) -class CatalogDeclarativePublisherDocumentPageTemplate(CatalogAnalyticsObjectBase): +class CatalogDeclarativePublisherDocumentPageTemplate(CatalogAnalyticsBaseMeta): title: str content: dict[str, Any] version: str diff --git a/packages/gooddata-sdk/tests/catalog/expected/declarative_analytics_model_documents.json b/packages/gooddata-sdk/tests/catalog/expected/declarative_analytics_model_documents.json index 9b4ac1bf6..d98f91872 100644 --- a/packages/gooddata-sdk/tests/catalog/expected/declarative_analytics_model_documents.json +++ b/packages/gooddata-sdk/tests/catalog/expected/declarative_analytics_model_documents.json @@ -39,6 +39,10 @@ "description": "Brand review", "tags": ["brand"], "version": "2", + "createdBy": {"id": "demo", "type": "user"}, + "createdAt": "2000-01-01 00:00", + "modifiedBy": {"id": "demo", "type": "user"}, + "modifiedAt": "2026-11-03 09:30", "content": { "locale": "en-US", "pages": [ @@ -58,6 +62,10 @@ "description": "Cover", "tags": ["brand"], "version": "2", + "createdBy": {"id": "demo", "type": "user"}, + "createdAt": "2000-01-01 00:00", + "modifiedBy": {"id": "demo", "type": "user"}, + "modifiedAt": "2026-11-03 09:30", "content": {"layout": {"type": "text", "id": "t1", "markdown": "Hello"}} } ] diff --git a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_documents_store_load_and_put.yaml b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_documents_store_load_and_put.yaml index a3df93b39..a4dff7cc3 100644 --- a/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_documents_store_load_and_put.yaml +++ b/packages/gooddata-sdk/tests/catalog/fixtures/workspace_content/demo_documents_store_load_and_put.yaml @@ -930,8 +930,16 @@ interactions: markdown: Hello type: text type: row + createdAt: 2000-01-01 00:00 + createdBy: + id: demo + type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -983,8 +991,16 @@ interactions: id: t1 markdown: Hello type: text + createdAt: 2000-01-01 00:00 + createdBy: + id: demo + type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1050,10 +1066,14 @@ interactions: type: row createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -1111,10 +1131,14 @@ interactions: type: text createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1133,7 +1157,7 @@ interactions: - nosniff X-GDC-TRACE-ID: *id001 content-length: - - '1479' + - '1623' status: code: 200 message: OK @@ -1251,10 +1275,14 @@ interactions: type: row createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -1312,10 +1340,14 @@ interactions: type: text createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1334,7 +1366,7 @@ interactions: - nosniff X-GDC-TRACE-ID: *id001 content-length: - - '1479' + - '1623' status: code: 200 message: OK @@ -1436,8 +1468,16 @@ interactions: markdown: Hello type: text type: row + createdAt: 2000-01-01 00:00 + createdBy: + id: demo + type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -1493,8 +1533,16 @@ interactions: id: t1 markdown: Hello type: text + createdAt: 2000-01-01 00:00 + createdBy: + id: demo + type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1562,10 +1610,14 @@ interactions: type: row createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -1623,10 +1675,14 @@ interactions: type: text createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1645,7 +1701,7 @@ interactions: - nosniff X-GDC-TRACE-ID: *id001 content-length: - - '1479' + - '1623' status: code: 200 message: OK @@ -1684,10 +1740,14 @@ interactions: type: row createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Brand review id: tpl_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Tpl 1 @@ -1745,10 +1805,14 @@ interactions: type: text createdAt: 2000-01-01 00:00 createdBy: - id: admin + id: demo type: user description: Cover id: pt_1 + modifiedAt: 2026-11-03 09:30 + modifiedBy: + id: demo + type: user tags: - brand title: Page 1 @@ -1767,7 +1831,7 @@ interactions: - nosniff X-GDC-TRACE-ID: *id001 content-length: - - '1479' + - '1623' status: code: 200 message: OK diff --git a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py index 24b1cc172..b4648b631 100644 --- a/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py +++ b/packages/gooddata-sdk/tests/catalog/test_catalog_workspace_content.py @@ -253,6 +253,8 @@ def test_documents_survive_store_load_and_put(test_config): with open(_current_dir / "expected" / "declarative_analytics_model_documents.json") as f: seed = json.load(f) seed_document = seed["analytics"]["documents"][0] + seed_document_template = seed["analytics"]["documentTemplates"][0] + seed_page_template = seed["analytics"]["pageTemplates"][0] try: _set_up_workspace_ldm(sdk, test_config["workspace"], identifier) @@ -276,6 +278,14 @@ def test_documents_survive_store_load_and_put(test_config): assert document.created_at == seed_document["createdAt"] assert document.modified_by.id == seed_document["modifiedBy"]["id"] assert document.modified_at == seed_document["modifiedAt"] + for template, seed_template in ( + (analytics_model_o.analytics.document_templates[0], seed_document_template), + (analytics_model_o.analytics.page_templates[0], seed_page_template), + ): + assert template.created_by.id == seed_template["createdBy"]["id"] + assert template.created_at == seed_template["createdAt"] + assert template.modified_by.id == seed_template["modifiedBy"]["id"] + assert template.modified_at == seed_template["modifiedAt"] page = document.to_api().to_dict(camel_case=True)["content"]["pages"][0] assert page["style"]["gap"] == 20 assert type(page["style"]["gap"]) is int diff --git a/packages/gooddata-sdk/tests/catalog/unit_tests/test_declarative_analytics_documents.py b/packages/gooddata-sdk/tests/catalog/unit_tests/test_declarative_analytics_documents.py index 31c2c8a7a..98bdc438f 100644 --- a/packages/gooddata-sdk/tests/catalog/unit_tests/test_declarative_analytics_documents.py +++ b/packages/gooddata-sdk/tests/catalog/unit_tests/test_declarative_analytics_documents.py @@ -66,12 +66,14 @@ "title": "Tpl 1", "version": "1", "content": {"locale": "en-US", "style": {"gap": 20}}, + **_AUTHOR, } _PAGE_TEMPLATE = { "id": "pt_1", "title": "Page 1", "version": "1", "content": {"style": {"gap": 20, "padding": _THEME_PADDING}, "layout": _STYLED_ROW}, + **_AUTHOR, } _LAYER = {"documents": [_DOCUMENT], "documentTemplates": [_DOCUMENT_TEMPLATE], "pageTemplates": [_PAGE_TEMPLATE]} _METRIC = {"id": "bmk_w_fraud_charged_back", "title": "BMK", "content": {"format": "#,##0", "maql": "SELECT 1"}} @@ -147,25 +149,58 @@ def test_document_author_fields_are_typed() -> None: assert document.modified_at == "2026-11-02 11:00" -@pytest.mark.parametrize( - ("layer_key", "attribute", "item_class", "item"), +_TEMPLATES = pytest.mark.parametrize( + ("layer_key", "attribute", "item_class", "item", "folder"), [ - ("documentTemplates", "document_templates", CatalogDeclarativePublisherDocumentTemplate, _DOCUMENT_TEMPLATE), - ("pageTemplates", "page_templates", CatalogDeclarativePublisherDocumentPageTemplate, _PAGE_TEMPLATE), + ( + "documentTemplates", + "document_templates", + CatalogDeclarativePublisherDocumentTemplate, + _DOCUMENT_TEMPLATE, + "document_templates", + ), + ( + "pageTemplates", + "page_templates", + CatalogDeclarativePublisherDocumentPageTemplate, + _PAGE_TEMPLATE, + "page_templates", + ), ], ids=["document_template", "page_template"], ) -def test_templates_have_no_author_attributes( - layer_key: str, attribute: str, item_class: type, item: dict[str, Any] + + +@_TEMPLATES +def test_template_author_fields_are_typed( + layer_key: str, attribute: str, item_class: type, item: dict[str, Any], folder: str ) -> None: layer = CatalogDeclarativeAnalyticsLayer.from_dict({layer_key: [item]}) template = getattr(layer, attribute)[0] assert isinstance(template, item_class) - assert not hasattr(template, "created_by") + assert template.created_by == CatalogUserIdentifier(id="admin", type="user") + assert template.created_at == "2026-11-02 10:00" + assert template.modified_by == CatalogUserIdentifier(id="admin", type="user") + assert template.modified_at == "2026-11-02 11:00" + + +@_TEMPLATES +def test_template_without_author_fields( + layer_key: str, attribute: str, item_class: type, item: dict[str, Any], folder: str +) -> None: + template_without_authors = {key: value for key, value in item.items() if key not in _AUTHOR} + layer = CatalogDeclarativeAnalyticsLayer.from_dict({layer_key: [template_without_authors]}) + + loaded = getattr(layer, attribute)[0] + + assert loaded.created_by is None + assert loaded.created_at is None + assert loaded.modified_by is None + assert loaded.modified_at is None round_tripped = _round_trip(layer)[layer_key] - _assert_same(round_tripped, [item]) + _assert_same(round_tripped, [template_without_authors]) assert not set(_AUTHOR) & set(round_tripped[0]) @@ -315,3 +350,22 @@ def test_load_document_yaml_without_author_fields(tmp_path: Path) -> None: assert loaded.created_at is None assert loaded.modified_by is None assert loaded.modified_at is None + + +@_TEMPLATES +def test_load_template_yaml_without_author_fields( + tmp_path: Path, layer_key: str, attribute: str, item_class: type, item: dict[str, Any], folder: str +) -> None: + template = {key: value for key, value in item.items() if key not in _AUTHOR} + template_folder = tmp_path / "analytics_model" / folder + template_folder.mkdir(parents=True) + write_layout_to_file(template_folder / f"{item['id']}.yaml", template) + + reloaded = CatalogDeclarativeAnalyticsLayer.load_from_disk(tmp_path) + + loaded = getattr(reloaded, attribute) + assert len(loaded) == 1 + assert loaded[0].created_by is None + assert loaded[0].created_at is None + assert loaded[0].modified_by is None + assert loaded[0].modified_at is None diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 133e36bad..abc8b047d 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -1600,6 +1600,96 @@ ], "type": "object" }, + "ComputationProfile": { + "description": "(EXPERIMENTAL) How the result was originally computed. Missing when unknown.", + "properties": { + "computedAt": { + "format": "int64", + "type": "integer" + }, + "finishedAt": { + "format": "int64", + "type": "integer" + }, + "finishedAtApprox": { + "type": "string" + }, + "sources": { + "items": { + "$ref": "#/components/schemas/ComputationProfileSource" + }, + "type": "array" + }, + "startedAt": { + "format": "int64", + "type": "integer" + }, + "totalDurationMs": { + "format": "int64", + "type": "integer" + }, + "v": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "computedAt", + "sources", + "v" + ], + "type": "object" + }, + "ComputationProfileSource": { + "properties": { + "dataSourceId": { + "type": "string" + }, + "dataSourceName": { + "type": "string" + }, + "dbDurationMs": { + "format": "int64", + "type": "integer" + }, + "finishedAt": { + "format": "int64", + "type": "integer" + }, + "queryDurationMs": { + "format": "int64", + "type": "integer" + }, + "queryFinishedAt": { + "format": "int64", + "type": "integer" + }, + "queryRequestedAt": { + "format": "int64", + "type": "integer" + }, + "queryStartedAt": { + "format": "int64", + "type": "integer" + }, + "resultId": { + "type": "string" + }, + "rows": { + "format": "int64", + "type": "integer" + }, + "streamingStartedAt": { + "format": "int64", + "type": "integer" + }, + "totalDurationMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, "DataColumnLocator": { "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": { @@ -1723,6 +1813,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2463,6 +2556,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -3021,6 +3117,22 @@ ], "type": "object" }, + "GoodDataAiProviderConfig": { + "description": "Configuration for GoodData AI provider. Inference is served by GoodData; no credentials are needed.", + "properties": { + "type": { + "description": "Provider type.", + "enum": [ + "GOODDATA_AI" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "HeaderGroup": { "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", "properties": { @@ -3559,6 +3671,9 @@ { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" + }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } @@ -4067,12 +4182,13 @@ "type": "string" }, "kind": { - "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n", + "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n* `refresh-data-source` — Refresh of an AI Lake data source after a data load.\n", "enum": [ "provision-database", "deprovision-database", "run-service-command", - "analyze-statistics" + "analyze-statistics", + "refresh-data-source" ], "type": "string" }, @@ -4266,6 +4382,46 @@ ], "type": "object" }, + "ParameterizedDateFilter": { + "description": "A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range.", + "properties": { + "parameterizedDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + } + }, + "required": [ + "dataset", + "parameter" + ], + "type": "object" + } + }, + "required": [ + "parameterizedDateFilter" + ], + "type": "object" + }, "PendingOperation": { "allOf": [ { @@ -4855,6 +5011,9 @@ "afm": { "$ref": "#/components/schemas/AFM" }, + "computationProfile": { + "$ref": "#/components/schemas/ComputationProfile" + }, "executionResponse": { "$ref": "#/components/schemas/ExecutionResponse" }, @@ -4946,6 +5105,9 @@ }, "type": "object" }, + "ServerSentEventString": { + "type": "object" + }, "ServiceInfo": { "description": "Non-sensitive metadata for an AI Lake pipeline", "properties": { @@ -6420,6 +6582,52 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId}": { + "get": { + "description": "Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event.", + "operationId": "streamExecutionProgress", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "executionId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "text/event-stream": { + "schema": { + "items": { + "$ref": "#/components/schemas/ServerSentEventString" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "(EXPERIMENTAL) Stream the live progress of an AFM execution", + "tags": [ + "Computation", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { "get": { "description": "Gets a single execution result.", @@ -8552,6 +8760,79 @@ } } }, + "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh": { + "post": { + "description": "(BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error.", + "operationId": "refreshAiLakeDataSource", + "parameters": [ + { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", + "in": "path", + "name": "instanceId", + "required": true, + "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", + "type": "string" + } + }, + { + "description": "Data source identifier.", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "description": "Data source identifier.", + "type": "string" + } + }, + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": {}, + "description": "Refresh scheduled.", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + }, + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + } + } + }, + "summary": "(BETA) Refresh an AI Lake data source", + "tags": [ + "AI Lake - Databases", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to refresh a data source.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/ailake/objectStorages": { "get": { "description": "(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", @@ -8666,7 +8947,7 @@ "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to get details of a Long Running Operation.", + "description": "Permissions required to get details of a Long Running Operation. MANAGE on the organization gives access to all operations. MANAGE on a data source gives access to the refresh operations of that data source.", "permissions": [ "MANAGE" ] diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index dc4e82fb1..e810e789d 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -148,7 +148,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -3288,6 +3288,96 @@ ], "type": "object" }, + "ComputationProfile": { + "description": "(EXPERIMENTAL) How the result was originally computed. Missing when unknown.", + "properties": { + "computedAt": { + "format": "int64", + "type": "integer" + }, + "finishedAt": { + "format": "int64", + "type": "integer" + }, + "finishedAtApprox": { + "type": "string" + }, + "sources": { + "items": { + "$ref": "#/components/schemas/ComputationProfileSource" + }, + "type": "array" + }, + "startedAt": { + "format": "int64", + "type": "integer" + }, + "totalDurationMs": { + "format": "int64", + "type": "integer" + }, + "v": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "computedAt", + "sources", + "v" + ], + "type": "object" + }, + "ComputationProfileSource": { + "properties": { + "dataSourceId": { + "type": "string" + }, + "dataSourceName": { + "type": "string" + }, + "dbDurationMs": { + "format": "int64", + "type": "integer" + }, + "finishedAt": { + "format": "int64", + "type": "integer" + }, + "queryDurationMs": { + "format": "int64", + "type": "integer" + }, + "queryFinishedAt": { + "format": "int64", + "type": "integer" + }, + "queryRequestedAt": { + "format": "int64", + "type": "integer" + }, + "queryStartedAt": { + "format": "int64", + "type": "integer" + }, + "resultId": { + "type": "string" + }, + "rows": { + "format": "int64", + "type": "integer" + }, + "streamingStartedAt": { + "format": "int64", + "type": "integer" + }, + "totalDurationMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, "ComputedAttributePermissions": { "properties": { "rules": { @@ -5305,6 +5395,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -5314,6 +5407,58 @@ ], "type": "object" }, + "DateRangeParameterDefinition": { + "properties": { + "defaultValue": { + "$ref": "#/components/schemas/DateRangeParameterValue" + }, + "type": { + "description": "The parameter type.", + "enum": [ + "DATE_RANGE" + ], + "type": "string" + } + }, + "required": [ + "defaultValue", + "type" + ], + "type": "object" + }, + "DateRangeParameterValue": { + "properties": { + "from": { + "description": "Start of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the start.", + "example": "2025-08", + "type": "string" + }, + "granularity": { + "description": "Granularity of the period; determines the format of 'from' and 'to'.", + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND" + ], + "example": "MONTH", + "type": "string" + }, + "to": { + "description": "End of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the end.", + "example": "2026-08", + "type": "string" + } + }, + "required": [ + "granularity" + ], + "type": "object" + }, "DateValue": { "properties": { "value": { @@ -5818,6 +5963,13 @@ }, "type": "array" }, + "metricExtensions": { + "description": "A list of metric permissions assigned to a related metric.", + "items": { + "$ref": "#/components/schemas/DeclarativeMetricExtension" + }, + "type": "array" + }, "metrics": { "description": "A list of metrics available in the model.", "items": { @@ -5860,6 +6012,13 @@ }, "type": "array" }, + "visualizationObjectExtensions": { + "description": "A list of visualization object permissions assigned to a related visualization object.", + "items": { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectExtension" + }, + "type": "array" + }, "visualizationObjects": { "description": "A list of visualization objects available in the model.", "items": { @@ -7981,9 +8140,37 @@ ], "type": "object" }, + "DeclarativeMetricExtension": { + "properties": { + "id": { + "description": "Metric ID.", + "example": "total-sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "permissions": { + "description": "A list of permissions.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssigneeRule" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "permissions" + ], + "type": "object" + }, "DeclarativeMetricPermissionAssignment": { "description": "Metric permission.", - "nullable": true, "properties": { "name": { "description": "Permission name.", @@ -8501,6 +8688,16 @@ "content": { "$ref": "#/components/schemas/PublisherDocumentPageTemplateContent" }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "description": { "description": "Page template description.", "maxLength": 10000, @@ -8512,6 +8709,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "tags": { "items": { "description": "A list of tags.", @@ -8545,6 +8752,16 @@ "content": { "$ref": "#/components/schemas/PublisherDocumentContent" }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "description": { "description": "Document template description.", "maxLength": 10000, @@ -8556,6 +8773,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "tags": { "items": { "description": "A list of tags.", @@ -8945,6 +9172,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -8958,7 +9187,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "example": "TIMEZONE", "type": "string" @@ -9563,9 +9794,37 @@ ], "type": "object" }, + "DeclarativeVisualizationObjectExtension": { + "properties": { + "id": { + "description": "Visualization object ID.", + "example": "revenue-by-region", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "permissions": { + "description": "A list of permissions.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssigneeRule" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "permissions" + ], + "type": "object" + }, "DeclarativeVisualizationObjectPermissionAssignment": { "description": "Visualization object permission.", - "nullable": true, "properties": { "name": { "description": "Permission name.", @@ -11463,6 +11722,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -12296,6 +12558,22 @@ ], "type": "object" }, + "GoodDataAiProviderConfig": { + "description": "Configuration for GoodData AI provider. Inference is served by GoodData; no credentials are needed.", + "properties": { + "type": { + "description": "Provider type.", + "enum": [ + "GOODDATA_AI" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "GrainIdentifier": { "description": "A grain identifier.", "example": { @@ -25624,6 +25902,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -25734,6 +26015,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -25884,6 +26168,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -28539,6 +28826,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -28552,7 +28841,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -28650,6 +28941,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -28663,7 +28956,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -28801,6 +29096,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -28814,7 +29111,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -28894,6 +29193,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -28905,6 +29205,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -29000,6 +29303,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -29011,6 +29315,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -29217,6 +29524,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -29228,6 +29536,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -29293,6 +29604,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -29304,6 +29616,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -38139,6 +38454,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -38249,6 +38566,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -41491,6 +41810,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -41601,6 +41922,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -41777,6 +42100,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -41887,6 +42212,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -42565,6 +42892,9 @@ { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" + }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } @@ -42693,6 +43023,100 @@ }, "type": "object" }, + "LocalizationIssue": { + "description": "One localization issue in one language.", + "properties": { + "locale": { + "description": "The problem language.", + "example": "fr-FR", + "type": "string" + }, + "type": { + "description": "The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added.", + "enum": [ + "METADATA_MISSING_TRANSLATION", + "METADATA_LANGUAGE_MISMATCH", + "METADATA_UNUSED_TRANSLATION" + ], + "type": "string" + }, + "workspaces": { + "description": "Organization issues only. The number of workspaces with this issue.", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "locale", + "type" + ], + "type": "object" + }, + "LocalizationIssueWorkspace": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "childrenCount": { + "description": "Number of direct child workspaces.", + "format": "int32", + "type": "integer" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parentId": { + "description": "The parent workspace, or null for a root workspace.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "bySetting", + "childrenCount", + "id", + "name" + ], + "type": "object" + }, + "LocalizationIssueWorkspaces": { + "properties": { + "totalCount": { + "description": "The total number of workspaces with this issue that match the name filter.", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/LocalizationIssueWorkspace" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "workspaces" + ], + "type": "object" + }, + "LocalizationIssues": { + "properties": { + "issues": { + "description": "Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong.", + "items": { + "$ref": "#/components/schemas/LocalizationIssue" + }, + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, "LocalizationMetadataStatistics": { "description": "Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.", "properties": { @@ -42701,6 +43125,13 @@ "$ref": "#/components/schemas/LocalizationStatisticsLocale" }, "type": "array" + }, + "workspaces": { + "description": "(BETA) Translation counts of the workspace and each parent workspace that the user can see, root first. Present only with `includeCoverage=true` on the workspace endpoint.", + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsWorkspace" + }, + "type": "array" } }, "required": [ @@ -42759,7 +43190,11 @@ "type": "object" }, "LocalizationSettingUsage": { + "description": "(BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it.", "properties": { + "childWorkspaces": { + "$ref": "#/components/schemas/LocalizationCount" + }, "users": { "$ref": "#/components/schemas/LocalizationCount" }, @@ -42846,6 +43281,68 @@ ], "type": "object" }, + "LocalizationStatisticsTranslatedLocale": { + "description": "Translated texts of one workspace in one language.", + "properties": { + "locale": { + "description": "Language tag.", + "example": "de-DE", + "type": "string" + }, + "translated": { + "description": "Texts of the workspace with a translation. A title, description or tag edited after its translation still counts.", + "example": 640, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "locale", + "translated" + ], + "type": "object" + }, + "LocalizationStatisticsWorkspace": { + "description": "Metadata texts of one workspace. A row counts only the texts that the workspace owns. A child workspace sums its row and the rows of its parents.", + "properties": { + "id": { + "description": "Workspace ID.", + "example": "retail-bergmann", + "type": "string" + }, + "locales": { + "description": "Every language of `metadata.locales`, sorted, with 0 where nothing is translated.", + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsTranslatedLocale" + }, + "type": "array" + }, + "name": { + "description": "Workspace name.", + "example": "Bergmann", + "type": "string" + }, + "parentId": { + "description": "Parent workspace ID, null for a root workspace.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "total": { + "description": "Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted.", + "example": 1000, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "id", + "locales", + "name", + "total" + ], + "type": "object" + }, "LocalizationUsage": { "properties": { "defaults": { @@ -42922,11 +43419,14 @@ "type": "object" }, "LocalizationUsageValue": { - "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting.", + "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting. (BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it.", "properties": { "bySetting": { "$ref": "#/components/schemas/LocalizationSettingUsages" }, + "childWorkspaces": { + "$ref": "#/components/schemas/LocalizationCount" + }, "content": { "$ref": "#/components/schemas/LocalizationContent" }, @@ -43991,12 +44491,13 @@ "type": "string" }, "kind": { - "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n", + "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n* `refresh-data-source` — Refresh of an AI Lake data source after a data load.\n", "enum": [ "provision-database", "deprovision-database", "run-service-command", - "analyze-statistics" + "analyze-statistics", + "refresh-data-source" ], "type": "string" }, @@ -44346,6 +44847,7 @@ "description": "Parameter content (type-discriminated).", "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -44357,6 +44859,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -44411,6 +44916,46 @@ ], "type": "object" }, + "ParameterizedDateFilter": { + "description": "A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range.", + "properties": { + "parameterizedDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + } + }, + "required": [ + "dataset", + "parameter" + ], + "type": "object" + } + }, + "required": [ + "parameterizedDateFilter" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -48624,7 +49169,7 @@ "type": "string" }, "visible": { - "description": "Default `true`.", + "description": "When left out, a visualization's title is hidden and a takeaway's is shown.", "type": "boolean" } }, @@ -49202,6 +49747,7 @@ "properties": { "from": { "format": "int32", + "nullable": true, "type": "integer" }, "granularity": { @@ -49258,6 +49804,7 @@ }, "to": { "format": "int32", + "nullable": true, "type": "integer" } }, @@ -49576,6 +50123,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -49589,7 +50138,8 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "AI_LAKE_CREDENTIAL_VENDING" ], "example": "TIMEZONE", "type": "string" @@ -49654,6 +50204,9 @@ "afm": { "$ref": "#/components/schemas/AFM" }, + "computationProfile": { + "$ref": "#/components/schemas/ComputationProfile" + }, "executionResponse": { "$ref": "#/components/schemas/ExecutionResponse" }, @@ -49982,6 +50535,9 @@ }, "type": "object" }, + "ServerSentEventString": { + "type": "object" + }, "ServiceInfo": { "description": "Non-sensitive metadata for an AI Lake pipeline", "properties": { @@ -52085,6 +52641,33 @@ ], "type": "object" }, + "ValidateEmbeddingOriginRequest": { + "description": "An origin to check against the embedding origins of the organization.", + "properties": { + "origin": { + "description": "The origin of the embedding application, or `*` when it hides its origin.", + "example": "https://app.example.com", + "type": "string" + } + }, + "required": [ + "origin" + ], + "type": "object" + }, + "ValidateEmbeddingOriginResponse": { + "description": "Whether the origin may embed the application.", + "properties": { + "valid": { + "description": "True when the embedding origins of the organization allow the origin.", + "type": "boolean" + } + }, + "required": [ + "valid" + ], + "type": "object" + }, "ValidityPeriodCacheRetention": { "description": "The cache expires once a fixed period elapses since the results were computed.", "properties": { @@ -54827,9 +55410,129 @@ ] } }, + "/api/v1/actions/organization/localization/issues": { + "get": { + "description": "(BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.", + "operationId": "organizationLocalizationIssues", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssues" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Localization issues of the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/issues/workspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.", + "operationId": "organizationLocalizationIssueWorkspaces", + "parameters": [ + { + "description": "The type of the issue.", + "example": "METADATA_MISSING_TRANSLATION", + "in": "query", + "name": "type", + "required": true, + "schema": { + "description": "The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added.", + "enum": [ + "METADATA_MISSING_TRANSLATION", + "METADATA_LANGUAGE_MISMATCH", + "METADATA_UNUSED_TRANSLATION" + ], + "type": "string" + } + }, + { + "description": "The language of the issue.", + "example": "de-DE", + "in": "query", + "name": "locale", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssueWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces with a localization issue.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/organization/localization/statistics": { "get": { - "description": "(BETA) Lists the languages that have at least one translation, separately for each kind of translation.", + "description": "Lists the languages that have at least one translation, separately for each kind of translation.", "operationId": "organizationLocalizationStatistics", "responses": { "200": { @@ -54843,7 +55546,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages with translations in the organization.", + "summary": "Languages with translations in the organization.", "tags": [ "Localization", "actions" @@ -54858,7 +55561,7 @@ }, "/api/v1/actions/organization/localization/usage": { "get": { - "description": "(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", + "description": "Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", "operationId": "organizationLocalizationUsage", "responses": { "200": { @@ -54872,7 +55575,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages used in the organization.", + "summary": "Languages used in the organization.", "tags": [ "Localization", "actions" @@ -54887,7 +55590,7 @@ }, "/api/v1/actions/organization/localization/usage/users": { "get": { - "description": "(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language.", "operationId": "organizationLocalizationUsageUsers", "parameters": [ { @@ -54981,7 +55684,7 @@ "description": "OK" } }, - "summary": "(BETA) Users who set a language themselves.", + "summary": "Users who set a language themselves.", "tags": [ "Localization", "actions" @@ -54996,7 +55699,7 @@ }, "/api/v1/actions/organization/localization/usage/workspaces": { "get": { - "description": "(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language.", "operationId": "organizationLocalizationUsageWorkspaces", "parameters": [ { @@ -55090,7 +55793,7 @@ "description": "OK" } }, - "summary": "(BETA) Workspaces that use a language.", + "summary": "Workspaces that use a language.", "tags": [ "Localization", "actions" @@ -55857,6 +56560,39 @@ ] } }, + "/api/v1/actions/validateEmbeddingOrigin": { + "post": { + "description": "Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.", + "operationId": "validateEmbeddingOrigin", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateEmbeddingOriginRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateEmbeddingOriginResponse" + } + } + }, + "description": "Whether the origin may embed the application." + } + }, + "summary": "Validate an embedding origin.", + "tags": [ + "Reporting - Settings", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { "get": { "description": "Returns a list of Users who created any object for this workspace", @@ -57005,7 +57741,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Computed Attribute", + "summary": "Manage Permissions for a Computed Attribute", "tags": [ "Permissions", "actions" @@ -57045,7 +57781,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Computed Attribute Permissions", + "summary": "Get Computed Attribute Permissions", "tags": [ "Permissions", "actions" @@ -57373,6 +58109,52 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/progress/{executionId}": { + "get": { + "description": "Server-Sent Events with the computation steps of the execution identified by the X-GDC-CANCEL-TOKEN of the execute request. Ends with a `done` event.", + "operationId": "streamExecutionProgress", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "executionId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "text/event-stream": { + "schema": { + "items": { + "$ref": "#/components/schemas/ServerSentEventString" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "(EXPERIMENTAL) Stream the live progress of an AFM execution", + "tags": [ + "Computation", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { "get": { "description": "Gets a single execution result.", @@ -59366,7 +60148,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/raw": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "description": "A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", "operationId": "createRawExport", "parameters": [ { @@ -59400,7 +60182,7 @@ "description": "Raw export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create raw export request", + "summary": "Create raw export request", "tags": [ "Raw export", "actions" @@ -59415,7 +60197,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "description": "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", "operationId": "getRawExport", "parameters": [ { @@ -59493,7 +60275,7 @@ "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", + "summary": "Retrieve exported files", "tags": [ "Raw export", "actions" @@ -60588,9 +61370,48 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/localization/issues": { + "get": { + "description": "(BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them.", + "operationId": "workspaceLocalizationIssues", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssues" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Localization issues of the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/localization/statistics": { "get": { - "description": "(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.", + "description": "Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.", "operationId": "workspaceLocalizationStatistics", "parameters": [ { @@ -60600,6 +61421,15 @@ "schema": { "type": "string" } + }, + { + "description": "(BETA) Adds translation counts for the workspace and each parent, root first.", + "in": "query", + "name": "includeCoverage", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -60614,7 +61444,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages with translations in the workspace.", + "summary": "Languages with translations in the workspace.", "tags": [ "Localization", "actions" @@ -60629,7 +61459,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/localization/usage": { "get": { - "description": "(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.", + "description": "Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way.", "operationId": "workspaceLocalizationUsage", "parameters": [ { @@ -60653,7 +61483,124 @@ "description": "OK" } }, - "summary": "(BETA) Languages used in the workspace.", + "summary": "Languages used in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language.", + "operationId": "workspaceLocalizationUsageChildWorkspaces", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Language tag that the workspace gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "PARENT", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces below the workspace that use a language.", "tags": [ "Localization", "actions" @@ -60668,7 +61615,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/localization/usage/users": { "get": { - "description": "(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language.", "operationId": "workspaceLocalizationUsageUsers", "parameters": [ { @@ -60770,7 +61717,7 @@ "description": "OK" } }, - "summary": "(BETA) Workspace members who get a language.", + "summary": "Workspace members who get a language.", "tags": [ "Localization", "actions" @@ -60872,7 +61819,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Metric", + "summary": "Manage Permissions for a Metric", "tags": [ "Permissions", "actions" @@ -60912,7 +61859,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Metric Permissions", + "summary": "Get Metric Permissions", "tags": [ "Permissions", "actions" @@ -61510,7 +62457,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Visualization", + "summary": "Manage Permissions for a Visualization", "tags": [ "Permissions", "actions" @@ -61550,7 +62497,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Visualization Permissions", + "summary": "Get Visualization Permissions", "tags": [ "Permissions", "actions" @@ -62104,6 +63051,79 @@ } } }, + "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}/refresh": { + "post": { + "description": "(BETA) Brings the data source up to date after a load and drops its cached results. The request starts an operation. Poll the operation to see its progress. When the operation succeeds, queries return the new data after the usual cache propagation. A failed operation carries the reason in its error.", + "operationId": "refreshAiLakeDataSource", + "parameters": [ + { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", + "in": "path", + "name": "instanceId", + "required": true, + "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", + "type": "string" + } + }, + { + "description": "Data source identifier.", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "description": "Data source identifier.", + "type": "string" + } + }, + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "content": {}, + "description": "Refresh scheduled.", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + }, + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + } + } + }, + "summary": "(BETA) Refresh an AI Lake data source", + "tags": [ + "AI Lake - Databases", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to refresh a data source.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/ailake/objectStorages": { "get": { "description": "(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", @@ -62218,7 +63238,7 @@ "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to get details of a Long Running Operation.", + "description": "Permissions required to get details of a Long Running Operation. MANAGE on the organization gives access to all operations. MANAGE on a data source gives access to the refresh operations of that data source.", "permissions": [ "MANAGE" ] @@ -70491,7 +71511,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Facts", "entities", @@ -70940,7 +71960,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Dashboards", "entities", @@ -71624,7 +72644,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Attribute Hierarchies", "entities", @@ -72180,7 +73200,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Attributes", "entities", @@ -72393,7 +73413,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch an Attribute", "tags": [ "Attributes", "entities", @@ -72472,7 +73492,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Automations", "entities", @@ -72809,7 +73829,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Automations", "entities", @@ -73519,7 +74539,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Computed Attributes", "entities", @@ -74146,7 +75166,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Workspaces - Settings", "entities", @@ -74715,7 +75735,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Plugins", "entities", @@ -75268,7 +76288,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Datasets", "entities", @@ -75482,7 +76502,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Patch a Dataset", "tags": [ "Datasets", "entities", @@ -76305,6 +77325,85 @@ } } }, + "/api/v1/entities/workspaces/{workspaceId}/documents/search": { + "post": { + "operationId": "searchEntities@Documents", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitySearchBody" + } + } + }, + "description": "Search request body with filter, pagination, and sorting options", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}": { "delete": { "operationId": "deleteEntity@Documents", @@ -76965,7 +78064,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Export Definitions", "entities", @@ -77533,7 +78632,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Facts", "entities", @@ -77740,7 +78839,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Fact (beta)", + "summary": "Patch a Fact", "tags": [ "Facts", "entities", @@ -78055,7 +79154,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Filter Context", "entities", @@ -78693,7 +79792,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Filter Views", "entities", @@ -79504,7 +80603,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Knowledge Recommendations", "entities", @@ -80057,7 +81156,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Labels", "entities", @@ -80264,7 +81363,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Label", "tags": [ "Labels", "entities", @@ -80573,7 +81672,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Memory Items", "entities", @@ -81241,7 +82340,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Metrics", "entities", @@ -82488,7 +83587,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Parameters", "entities", @@ -84867,7 +85966,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -85559,7 +86658,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Visualization Object", "entities", @@ -86674,7 +87773,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -87319,7 +88418,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -88360,7 +89459,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Workspaces - Settings", "entities", diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index 8ecc69af9..898c3ee71 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -2431,6 +2431,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2649,6 +2652,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -3286,6 +3292,46 @@ ], "type": "object" }, + "ParameterizedDateFilter": { + "description": "A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range.", + "properties": { + "parameterizedDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + } + }, + "required": [ + "dataset", + "parameter" + ], + "type": "object" + } + }, + "required": [ + "parameterizedDateFilter" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -3782,6 +3828,7 @@ "properties": { "from": { "format": "int32", + "nullable": true, "type": "integer" }, "granularity": { @@ -3838,6 +3885,7 @@ }, "to": { "format": "int32", + "nullable": true, "type": "integer" } }, diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 4d05c21f5..e87fb53c0 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -1882,6 +1882,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -1962,6 +1965,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2389,6 +2395,46 @@ ], "type": "object" }, + "ParameterizedDateFilter": { + "description": "A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range.", + "properties": { + "parameterizedDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + } + }, + "required": [ + "dataset", + "parameter" + ], + "type": "object" + } + }, + "required": [ + "parameterizedDateFilter" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -2819,6 +2865,7 @@ "properties": { "from": { "format": "int32", + "nullable": true, "type": "integer" }, "granularity": { @@ -2875,6 +2922,7 @@ }, "to": { "format": "int32", + "nullable": true, "type": "integer" } }, @@ -3841,7 +3889,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/raw": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "description": "A raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", "operationId": "createRawExport", "parameters": [ { @@ -3875,7 +3923,7 @@ "description": "Raw export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create raw export request", + "summary": "Create raw export request", "tags": [ "Raw export", "actions" @@ -3890,7 +3938,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "description": "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", "operationId": "getRawExport", "parameters": [ { @@ -3968,7 +4016,7 @@ "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", + "summary": "Retrieve exported files", "tags": [ "Raw export", "actions" diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 2d6dfe0ce..17d3f6a32 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -148,7 +148,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. When both are provided, 'from' must not be after 'to'.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -3431,6 +3431,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -3440,6 +3443,58 @@ ], "type": "object" }, + "DateRangeParameterDefinition": { + "properties": { + "defaultValue": { + "$ref": "#/components/schemas/DateRangeParameterValue" + }, + "type": { + "description": "The parameter type.", + "enum": [ + "DATE_RANGE" + ], + "type": "string" + } + }, + "required": [ + "defaultValue", + "type" + ], + "type": "object" + }, + "DateRangeParameterValue": { + "properties": { + "from": { + "description": "Start of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the start.", + "example": "2025-08", + "type": "string" + }, + "granularity": { + "description": "Granularity of the period; determines the format of 'from' and 'to'.", + "enum": [ + "YEAR", + "QUARTER", + "MONTH", + "WEEK", + "DAY", + "HOUR", + "MINUTE", + "SECOND" + ], + "example": "MONTH", + "type": "string" + }, + "to": { + "description": "End of the period (inclusive) in the format matching 'granularity'. If omitted, the period is unbounded at the end.", + "example": "2026-08", + "type": "string" + } + }, + "required": [ + "granularity" + ], + "type": "object" + }, "DateValue": { "properties": { "value": { @@ -3944,6 +3999,13 @@ }, "type": "array" }, + "metricExtensions": { + "description": "A list of metric permissions assigned to a related metric.", + "items": { + "$ref": "#/components/schemas/DeclarativeMetricExtension" + }, + "type": "array" + }, "metrics": { "description": "A list of metrics available in the model.", "items": { @@ -3986,6 +4048,13 @@ }, "type": "array" }, + "visualizationObjectExtensions": { + "description": "A list of visualization object permissions assigned to a related visualization object.", + "items": { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectExtension" + }, + "type": "array" + }, "visualizationObjects": { "description": "A list of visualization objects available in the model.", "items": { @@ -6107,9 +6176,37 @@ ], "type": "object" }, + "DeclarativeMetricExtension": { + "properties": { + "id": { + "description": "Metric ID.", + "example": "total-sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "permissions": { + "description": "A list of permissions.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssigneeRule" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "permissions" + ], + "type": "object" + }, "DeclarativeMetricPermissionAssignment": { "description": "Metric permission.", - "nullable": true, "properties": { "name": { "description": "Permission name.", @@ -6627,6 +6724,16 @@ "content": { "$ref": "#/components/schemas/PublisherDocumentPageTemplateContent" }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "description": { "description": "Page template description.", "maxLength": 10000, @@ -6638,6 +6745,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "tags": { "items": { "description": "A list of tags.", @@ -6671,6 +6788,16 @@ "content": { "$ref": "#/components/schemas/PublisherDocumentContent" }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "description": { "description": "Document template description.", "maxLength": 10000, @@ -6682,6 +6809,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, "tags": { "items": { "description": "A list of tags.", @@ -7071,6 +7208,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -7084,7 +7223,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "example": "TIMEZONE", "type": "string" @@ -7673,9 +7814,37 @@ ], "type": "object" }, + "DeclarativeVisualizationObjectExtension": { + "properties": { + "id": { + "description": "Visualization object ID.", + "example": "revenue-by-region", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "permissions": { + "description": "A list of permissions.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssigneeRule" + } + ] + }, + "type": "array" + } + }, + "required": [ + "id", + "permissions" + ], + "type": "object" + }, "DeclarativeVisualizationObjectPermissionAssignment": { "description": "Visualization object permission.", - "nullable": true, "properties": { "name": { "description": "Permission name.", @@ -8793,6 +8962,9 @@ { "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" }, + { + "$ref": "#/components/schemas/ParameterizedDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -8991,6 +9163,22 @@ ], "type": "object" }, + "GoodDataAiProviderConfig": { + "description": "Configuration for GoodData AI provider. Inference is served by GoodData; no credentials are needed.", + "properties": { + "type": { + "description": "Provider type.", + "enum": [ + "GOODDATA_AI" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "GrainIdentifier": { "description": "A grain identifier.", "example": { @@ -21841,6 +22029,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -21951,6 +22142,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -22101,6 +22295,9 @@ }, { "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/GoodDataAiProviderConfig" } ], "type": "object" @@ -24756,6 +24953,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -24769,7 +24968,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -24867,6 +25068,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -24880,7 +25083,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -25018,6 +25223,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -25031,7 +25238,9 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "EMBEDDING_ORIGINS", + "AI_LAKE_CREDENTIAL_VENDING" ], "type": "string" } @@ -25081,6 +25290,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -25092,6 +25302,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -25187,6 +25400,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -25198,6 +25412,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -25404,6 +25621,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -25415,6 +25633,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -25480,6 +25701,7 @@ "definition": { "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -25491,6 +25713,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -34326,6 +34551,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -34436,6 +34663,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -37678,6 +37907,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -37788,6 +38019,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -37964,6 +38197,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -38074,6 +38309,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -38657,6 +38894,100 @@ }, "type": "object" }, + "LocalizationIssue": { + "description": "One localization issue in one language.", + "properties": { + "locale": { + "description": "The problem language.", + "example": "fr-FR", + "type": "string" + }, + "type": { + "description": "The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added.", + "enum": [ + "METADATA_MISSING_TRANSLATION", + "METADATA_LANGUAGE_MISMATCH", + "METADATA_UNUSED_TRANSLATION" + ], + "type": "string" + }, + "workspaces": { + "description": "Organization issues only. The number of workspaces with this issue.", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "locale", + "type" + ], + "type": "object" + }, + "LocalizationIssueWorkspace": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "childrenCount": { + "description": "Number of direct child workspaces.", + "format": "int32", + "type": "integer" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parentId": { + "description": "The parent workspace, or null for a root workspace.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "bySetting", + "childrenCount", + "id", + "name" + ], + "type": "object" + }, + "LocalizationIssueWorkspaces": { + "properties": { + "totalCount": { + "description": "The total number of workspaces with this issue that match the name filter.", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/LocalizationIssueWorkspace" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "workspaces" + ], + "type": "object" + }, + "LocalizationIssues": { + "properties": { + "issues": { + "description": "Sorted by type in the order of the enum, then by locale. Empty when nothing is wrong.", + "items": { + "$ref": "#/components/schemas/LocalizationIssue" + }, + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, "LocalizationMetadataStatistics": { "description": "Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.", "properties": { @@ -38665,6 +38996,13 @@ "$ref": "#/components/schemas/LocalizationStatisticsLocale" }, "type": "array" + }, + "workspaces": { + "description": "(BETA) Translation counts of the workspace and each parent workspace that the user can see, root first. Present only with `includeCoverage=true` on the workspace endpoint.", + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsWorkspace" + }, + "type": "array" } }, "required": [ @@ -38723,7 +39061,11 @@ "type": "object" }, "LocalizationSettingUsage": { + "description": "(BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it.", "properties": { + "childWorkspaces": { + "$ref": "#/components/schemas/LocalizationCount" + }, "users": { "$ref": "#/components/schemas/LocalizationCount" }, @@ -38810,6 +39152,68 @@ ], "type": "object" }, + "LocalizationStatisticsTranslatedLocale": { + "description": "Translated texts of one workspace in one language.", + "properties": { + "locale": { + "description": "Language tag.", + "example": "de-DE", + "type": "string" + }, + "translated": { + "description": "Texts of the workspace with a translation. A title, description or tag edited after its translation still counts.", + "example": 640, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "locale", + "translated" + ], + "type": "object" + }, + "LocalizationStatisticsWorkspace": { + "description": "Metadata texts of one workspace. A row counts only the texts that the workspace owns. A child workspace sums its row and the rows of its parents.", + "properties": { + "id": { + "description": "Workspace ID.", + "example": "retail-bergmann", + "type": "string" + }, + "locales": { + "description": "Every language of `metadata.locales`, sorted, with 0 where nothing is translated.", + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsTranslatedLocale" + }, + "type": "array" + }, + "name": { + "description": "Workspace name.", + "example": "Bergmann", + "type": "string" + }, + "parentId": { + "description": "Parent workspace ID, null for a root workspace.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "total": { + "description": "Titles, descriptions, tags and free-form texts the workspace owns. Blank texts are not counted.", + "example": 1000, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "id", + "locales", + "name", + "total" + ], + "type": "object" + }, "LocalizationUsage": { "properties": { "defaults": { @@ -38886,11 +39290,14 @@ "type": "object" }, "LocalizationUsageValue": { - "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting.", + "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting. (BETA) `childWorkspaces` has the same counts for the workspaces below this workspace that the user can see. It does not count this workspace. Only the workspace usage has it.", "properties": { "bySetting": { "$ref": "#/components/schemas/LocalizationSettingUsages" }, + "childWorkspaces": { + "$ref": "#/components/schemas/LocalizationCount" + }, "content": { "$ref": "#/components/schemas/LocalizationContent" }, @@ -39648,6 +40055,7 @@ "description": "Parameter content (type-discriminated).", "discriminator": { "mapping": { + "DATE_RANGE": "#/components/schemas/DateRangeParameterDefinition", "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, @@ -39659,6 +40067,9 @@ }, { "$ref": "#/components/schemas/StringParameterDefinition" + }, + { + "$ref": "#/components/schemas/DateRangeParameterDefinition" } ], "type": "object" @@ -39713,6 +40124,46 @@ ], "type": "object" }, + "ParameterizedDateFilter": { + "description": "A date filter whose period comes from a DATE_RANGE parameter. Each execution uses the parameter's current granularity and range.", + "properties": { + "parameterizedDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + } + }, + "required": [ + "dataset", + "parameter" + ], + "type": "object" + } + }, + "required": [ + "parameterizedDateFilter" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -43873,7 +44324,7 @@ "type": "string" }, "visible": { - "description": "Default `true`.", + "description": "When left out, a visualization's title is hidden and a takeaway's is shown.", "type": "boolean" } }, @@ -44243,6 +44694,7 @@ "properties": { "from": { "format": "int32", + "nullable": true, "type": "integer" }, "granularity": { @@ -44299,6 +44751,7 @@ }, "to": { "format": "int32", + "nullable": true, "type": "integer" } }, @@ -44561,6 +45014,8 @@ "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_AI_TRACE_OBFUSCATION", + "ENABLE_AI_PERSISTENCE_OBFUSCATION", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", @@ -44574,7 +45029,8 @@ "DEFAULT_VISUALIZATION_VISIBILITY", "DEFAULT_METRIC_VISIBILITY", "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", - "QUERY_ENGINE" + "QUERY_ENGINE", + "AI_LAKE_CREDENTIAL_VENDING" ], "example": "TIMEZONE", "type": "string" @@ -45842,6 +46298,33 @@ ], "type": "object" }, + "ValidateEmbeddingOriginRequest": { + "description": "An origin to check against the embedding origins of the organization.", + "properties": { + "origin": { + "description": "The origin of the embedding application, or `*` when it hides its origin.", + "example": "https://app.example.com", + "type": "string" + } + }, + "required": [ + "origin" + ], + "type": "object" + }, + "ValidateEmbeddingOriginResponse": { + "description": "Whether the origin may embed the application.", + "properties": { + "valid": { + "description": "True when the embedding origins of the organization allow the origin.", + "type": "boolean" + } + }, + "required": [ + "valid" + ], + "type": "object" + }, "ValidityPeriodCacheRetention": { "description": "The cache expires once a fixed period elapses since the results were computed.", "properties": { @@ -46878,9 +47361,129 @@ ] } }, + "/api/v1/actions/organization/localization/issues": { + "get": { + "description": "(BETA) Counts the workspaces with each localization issue. The rules are the same as in the workspace localization issues.", + "operationId": "organizationLocalizationIssues", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssues" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Localization issues of the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/issues/workspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind one entry of the organization localization issues, sorted by name.", + "operationId": "organizationLocalizationIssueWorkspaces", + "parameters": [ + { + "description": "The type of the issue.", + "example": "METADATA_MISSING_TRANSLATION", + "in": "query", + "name": "type", + "required": true, + "schema": { + "description": "The kind of localization issue. The prefix names the area of the problem. METADATA_MISSING_TRANSLATION - the metadata language has no translation under exactly its code. When the metadata language is the default, the display language is checked instead. METADATA_LANGUAGE_MISMATCH - the display language has a translation, but the metadata language is not set to it. METADATA_UNUSED_TRANSLATION - the workspace owns a translation that nobody uses. No workspace in its subtree gets that language. No user has it as their own language. System accounts and the bootstrap user are not counted, as in the usage endpoints. New types may be added.", + "enum": [ + "METADATA_MISSING_TRANSLATION", + "METADATA_LANGUAGE_MISMATCH", + "METADATA_UNUSED_TRANSLATION" + ], + "type": "string" + } + }, + { + "description": "The language of the issue.", + "example": "de-DE", + "in": "query", + "name": "locale", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssueWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces with a localization issue.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/organization/localization/statistics": { "get": { - "description": "(BETA) Lists the languages that have at least one translation, separately for each kind of translation.", + "description": "Lists the languages that have at least one translation, separately for each kind of translation.", "operationId": "organizationLocalizationStatistics", "responses": { "200": { @@ -46894,7 +47497,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages with translations in the organization.", + "summary": "Languages with translations in the organization.", "tags": [ "Localization", "actions" @@ -46909,7 +47512,7 @@ }, "/api/v1/actions/organization/localization/usage": { "get": { - "description": "(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", + "description": "Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", "operationId": "organizationLocalizationUsage", "responses": { "200": { @@ -46923,7 +47526,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages used in the organization.", + "summary": "Languages used in the organization.", "tags": [ "Localization", "actions" @@ -46938,7 +47541,7 @@ }, "/api/v1/actions/organization/localization/usage/users": { "get": { - "description": "(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. An empty `value=` means no filter. The list leaves out the users that the usage counts without a language.", "operationId": "organizationLocalizationUsageUsers", "parameters": [ { @@ -47032,7 +47635,7 @@ "description": "OK" } }, - "summary": "(BETA) Users who set a language themselves.", + "summary": "Users who set a language themselves.", "tags": [ "Localization", "actions" @@ -47047,7 +47650,7 @@ }, "/api/v1/actions/organization/localization/usage/workspaces": { "get": { - "description": "(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language.", "operationId": "organizationLocalizationUsageWorkspaces", "parameters": [ { @@ -47141,7 +47744,7 @@ "description": "OK" } }, - "summary": "(BETA) Workspaces that use a language.", + "summary": "Workspaces that use a language.", "tags": [ "Localization", "actions" @@ -47908,6 +48511,39 @@ ] } }, + "/api/v1/actions/validateEmbeddingOrigin": { + "post": { + "description": "Checks one origin against the embedding origins of the organization. The literal `*` is valid only when the embedding origins contain `*`.", + "operationId": "validateEmbeddingOrigin", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateEmbeddingOriginRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidateEmbeddingOriginResponse" + } + } + }, + "description": "Whether the origin may embed the application." + } + }, + "summary": "Validate an embedding origin.", + "tags": [ + "Reporting - Settings", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { "get": { "description": "Returns a list of Users who created any object for this workspace", @@ -48510,7 +49146,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Computed Attribute", + "summary": "Manage Permissions for a Computed Attribute", "tags": [ "Permissions", "actions" @@ -48550,7 +49186,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Computed Attribute Permissions", + "summary": "Get Computed Attribute Permissions", "tags": [ "Permissions", "actions" @@ -48917,9 +49553,48 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/localization/issues": { + "get": { + "description": "(BETA) Checks the display and metadata language of the workspace against the metadata translations of the workspace and its parents. It also reports translations the workspace owns that nobody uses. It checks this only when the workspace has no workspaces below it or the user can see all of them.", + "operationId": "workspaceLocalizationIssues", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationIssues" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Localization issues of the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/localization/statistics": { "get": { - "description": "(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.", + "description": "Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. With includeCoverage=true, it also counts the translated metadata texts of the workspace and each parent.", "operationId": "workspaceLocalizationStatistics", "parameters": [ { @@ -48929,6 +49604,15 @@ "schema": { "type": "string" } + }, + { + "description": "(BETA) Adds translation counts for the workspace and each parent, root first.", + "in": "query", + "name": "includeCoverage", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -48943,7 +49627,7 @@ "description": "OK" } }, - "summary": "(BETA) Languages with translations in the workspace.", + "summary": "Languages with translations in the workspace.", "tags": [ "Localization", "actions" @@ -48958,7 +49642,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/localization/usage": { "get": { - "description": "(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.", + "description": "Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. `childWorkspaces` counts the workspaces below it that the user can see, the same way.", "operationId": "workspaceLocalizationUsage", "parameters": [ { @@ -48982,7 +49666,124 @@ "description": "OK" } }, - "summary": "(BETA) Languages used in the workspace.", + "summary": "Languages used in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage/childWorkspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind the `childWorkspaces` counts of the workspace localization usage. The list has the workspaces below the workspace that the user can see, sorted by name. Without the setting filter, a workspace matches when one of its three language settings matches. Its source is then the strongest one. Without the value filter, a setting without a language matches too. An empty `value=` means no filter. The `value` parameter cannot filter for a missing language.", + "operationId": "workspaceLocalizationUsageChildWorkspaces", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Language tag that the workspace gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "PARENT", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces below the workspace that use a language.", "tags": [ "Localization", "actions" @@ -48997,7 +49798,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/localization/usage/users": { "get": { - "description": "(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. No value selects the usage entry without a language.", + "description": "Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. An empty `value=` means no filter. The list leaves out the members that the usage counts without a language.", "operationId": "workspaceLocalizationUsageUsers", "parameters": [ { @@ -49099,7 +49900,7 @@ "description": "OK" } }, - "summary": "(BETA) Workspace members who get a language.", + "summary": "Workspace members who get a language.", "tags": [ "Localization", "actions" @@ -49201,7 +50002,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Metric", + "summary": "Manage Permissions for a Metric", "tags": [ "Permissions", "actions" @@ -49241,7 +50042,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Metric Permissions", + "summary": "Get Metric Permissions", "tags": [ "Permissions", "actions" @@ -49839,7 +50640,7 @@ "description": "No Content" } }, - "summary": "(BETA) Manage Permissions for a Visualization", + "summary": "Manage Permissions for a Visualization", "tags": [ "Permissions", "actions" @@ -49879,7 +50680,7 @@ "description": "OK" } }, - "summary": "(BETA) Get Visualization Permissions", + "summary": "Get Visualization Permissions", "tags": [ "Permissions", "actions" @@ -57964,7 +58765,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Facts", "entities", @@ -58413,7 +59214,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Dashboards", "entities", @@ -59097,7 +59898,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Attribute Hierarchies", "entities", @@ -59653,7 +60454,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Attributes", "entities", @@ -59866,7 +60667,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch an Attribute", "tags": [ "Attributes", "entities", @@ -59945,7 +60746,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Automations", "entities", @@ -60282,7 +61083,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Automations", "entities", @@ -60992,7 +61793,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Computed Attributes", "entities", @@ -61619,7 +62420,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Workspaces - Settings", "entities", @@ -62188,7 +62989,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Plugins", "entities", @@ -62741,7 +63542,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Datasets", "entities", @@ -62955,7 +63756,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Patch a Dataset", "tags": [ "Datasets", "entities", @@ -63778,6 +64579,85 @@ } } }, + "/api/v1/entities/workspaces/{workspaceId}/documents/search": { + "post": { + "operationId": "searchEntities@Documents", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitySearchBody" + } + } + }, + "description": "Search request body with filter, pagination, and sorting options", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}": { "delete": { "operationId": "deleteEntity@Documents", @@ -64438,7 +65318,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Export Definitions", "entities", @@ -65006,7 +65886,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Facts", "entities", @@ -65213,7 +66093,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Fact (beta)", + "summary": "Patch a Fact", "tags": [ "Facts", "entities", @@ -65528,7 +66408,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Filter Context", "entities", @@ -66166,7 +67046,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Filter Views", "entities", @@ -66977,7 +67857,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Knowledge Recommendations", "entities", @@ -67530,7 +68410,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Labels", "entities", @@ -67737,7 +68617,7 @@ "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Label", "tags": [ "Labels", "entities", @@ -68046,7 +68926,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Memory Items", "entities", @@ -68714,7 +69594,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Metrics", "entities", @@ -69961,7 +70841,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Parameters", "entities", @@ -72340,7 +73220,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -73032,7 +73912,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Visualization Object", "entities", @@ -74147,7 +75027,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -74792,7 +75672,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Data Filters", "entities", @@ -75833,7 +76713,7 @@ "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "The search endpoint", "tags": [ "Workspaces - Settings", "entities",