diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 1c89c5181..b9d58d6ca 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -1,16 +1,18 @@ .gitignore README.md docs/AFM.md -docs/AFMFiltersInner.md docs/AIAgentsApi.md docs/AIApi.md docs/AILakeApi.md docs/AILakeDatabasesApi.md docs/AILakePipeTablesApi.md docs/AILakeServicesOperationsApi.md +docs/AIObservabilityApi.md docs/APITokensApi.md docs/AbsoluteDateFilter.md docs/AbsoluteDateFilterAbsoluteDateFilter.md +docs/AbsoluteGranularityDateFilter.md +docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md docs/AbstractMeasureValueFilter.md docs/ActionsApi.md docs/ActiveObjectIdentification.md @@ -103,7 +105,6 @@ docs/AttributeResultHeader.md docs/AttributesApi.md docs/AuthenticationApi.md docs/AutomationAlert.md -docs/AutomationAlertCondition.md docs/AutomationControllerApi.md docs/AutomationDashboardTabularExport.md docs/AutomationExternalRecipient.md @@ -132,11 +133,16 @@ docs/BedrockProviderAuth.md docs/BoundedFilter.md docs/CSPDirectivesApi.md docs/CacheRemovalInterval.md +docs/CacheRetention.md +docs/CacheRetentionSchedule.md docs/CacheUsageApi.md docs/CacheUsageData.md +docs/CalendarDefinition.md +docs/CalendarGranularity.md +docs/CalendarTableReference.md docs/CertificationApi.md +docs/CertificationInfo.md docs/ChangeAnalysisParams.md -docs/ChangeAnalysisParamsFiltersInner.md docs/ChangeAnalysisRequest.md docs/ChangeAnalysisResponse.md docs/ChangeAnalysisResult.md @@ -178,6 +184,9 @@ docs/CookieSecurityConfigurationApi.md docs/CookieSecurityConfigurationControllerApi.md docs/CoverSlideTemplate.md docs/CreatePipeTableRequest.md +docs/CreatePipeTableRequestDistributionConfig.md +docs/CreatePipeTableRequestKeyConfig.md +docs/CreatePipeTableRequestPartitionConfig.md docs/CreatedVisualization.md docs/CreatedVisualizationFiltersInner.md docs/CreatedVisualizations.md @@ -188,6 +197,8 @@ docs/CsvManifestBody.md docs/CsvParseOptions.md docs/CsvReadOptions.md docs/CustomApplicationSettingControllerApi.md +docs/CustomCalendarDefinition.md +docs/CustomCalendarDefinitionAllOf.md docs/CustomGeoCollectionControllerApi.md docs/CustomLabel.md docs/CustomMetric.md @@ -212,7 +223,6 @@ docs/DashboardMatchAttributeFilter.md docs/DashboardMatchAttributeFilterMatchAttributeFilter.md docs/DashboardMeasureValueFilter.md docs/DashboardMeasureValueFilterDashboardMeasureValueFilter.md -docs/DashboardParameterValue.md docs/DashboardPermissions.md docs/DashboardPermissionsAssignment.md docs/DashboardPluginControllerApi.md @@ -271,6 +281,7 @@ docs/DeclarativeAnalyticsLayer.md docs/DeclarativeAttribute.md docs/DeclarativeAttributeHierarchy.md docs/DeclarativeAutomation.md +docs/DeclarativeCalendar.md docs/DeclarativeColorPalette.md docs/DeclarativeColumn.md docs/DeclarativeCspDirective.md @@ -288,7 +299,6 @@ docs/DeclarativeDatasetSql.md docs/DeclarativeDateDataset.md docs/DeclarativeExportDefinition.md docs/DeclarativeExportDefinitionIdentifier.md -docs/DeclarativeExportDefinitionRequestPayload.md docs/DeclarativeExportTemplate.md docs/DeclarativeExportTemplates.md docs/DeclarativeFact.md @@ -306,14 +316,12 @@ docs/DeclarativeMemoryItem.md docs/DeclarativeMetric.md docs/DeclarativeModel.md docs/DeclarativeNotificationChannel.md -docs/DeclarativeNotificationChannelDestination.md docs/DeclarativeNotificationChannelIdentifier.md docs/DeclarativeNotificationChannels.md docs/DeclarativeOrganization.md docs/DeclarativeOrganizationInfo.md docs/DeclarativeOrganizationPermission.md docs/DeclarativeParameter.md -docs/DeclarativeParameterContent.md docs/DeclarativeReference.md docs/DeclarativeReferenceSource.md docs/DeclarativeRsaSpecification.md @@ -338,14 +346,17 @@ docs/DeclarativeUsers.md docs/DeclarativeUsersUserGroups.md docs/DeclarativeVisualizationObject.md docs/DeclarativeWorkspace.md +docs/DeclarativeWorkspaceColorPalette.md docs/DeclarativeWorkspaceDataFilter.md docs/DeclarativeWorkspaceDataFilterColumn.md docs/DeclarativeWorkspaceDataFilterReferences.md docs/DeclarativeWorkspaceDataFilterSetting.md docs/DeclarativeWorkspaceDataFilters.md +docs/DeclarativeWorkspaceExportTemplate.md docs/DeclarativeWorkspaceHierarchyPermission.md docs/DeclarativeWorkspaceModel.md docs/DeclarativeWorkspacePermissions.md +docs/DeclarativeWorkspaceTheme.md docs/DeclarativeWorkspaces.md docs/DefaultSmtp.md docs/DefaultSmtpAllOf.md @@ -412,6 +423,10 @@ docs/FilterDefinition.md docs/FilterDefinitionForSimpleMeasure.md docs/FilterViewControllerApi.md docs/FilterViewsApi.md +docs/FiscalCalendarControllerApi.md +docs/FiscalCalendarsApi.md +docs/FiscalYearCalendarDefinition.md +docs/FiscalYearCalendarDefinitionAllOf.md docs/ForecastConfig.md docs/ForecastRequest.md docs/ForecastResult.md @@ -420,6 +435,8 @@ docs/Frequency.md docs/FrequencyBucket.md docs/FrequencyProperties.md docs/GdStorageFile.md +docs/GenAiRankingFilter.md +docs/GenAiRankingFilterAllOf.md docs/GenerateDescriptionRequest.md docs/GenerateDescriptionResponse.md docs/GenerateLdmRequest.md @@ -462,6 +479,7 @@ docs/ImportGeoCollectionRequest.md docs/ImportGeoCollectionResponse.md docs/InPlatform.md docs/InPlatformAllOf.md +docs/IndefiniteCacheRetention.md docs/InlineFilterDefinition.md docs/InlineFilterDefinitionInline.md docs/InlineMeasureDefinition.md @@ -686,6 +704,7 @@ docs/JsonApiDataSourceIdentifierOutMeta.md docs/JsonApiDataSourceIdentifierOutWithLinks.md docs/JsonApiDataSourceIn.md docs/JsonApiDataSourceInAttributes.md +docs/JsonApiDataSourceInAttributesCacheRetention.md docs/JsonApiDataSourceInAttributesParametersInner.md docs/JsonApiDataSourceInDocument.md docs/JsonApiDataSourceOut.md @@ -796,6 +815,13 @@ docs/JsonApiFilterViewOutWithLinks.md docs/JsonApiFilterViewPatch.md docs/JsonApiFilterViewPatchAttributes.md docs/JsonApiFilterViewPatchDocument.md +docs/JsonApiFiscalCalendarOut.md +docs/JsonApiFiscalCalendarOutAttributes.md +docs/JsonApiFiscalCalendarOutAttributesDefinition.md +docs/JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md +docs/JsonApiFiscalCalendarOutDocument.md +docs/JsonApiFiscalCalendarOutList.md +docs/JsonApiFiscalCalendarOutWithLinks.md docs/JsonApiIdentityProviderIn.md docs/JsonApiIdentityProviderInAttributes.md docs/JsonApiIdentityProviderInDocument.md @@ -933,6 +959,17 @@ docs/JsonApiNotificationChannelPatchDocument.md docs/JsonApiNotificationChannelPostOptionalId.md docs/JsonApiNotificationChannelPostOptionalIdDocument.md docs/JsonApiNotificationChannelToOneLinkage.md +docs/JsonApiOrgMemoryItemIn.md +docs/JsonApiOrgMemoryItemInAttributes.md +docs/JsonApiOrgMemoryItemInDocument.md +docs/JsonApiOrgMemoryItemOut.md +docs/JsonApiOrgMemoryItemOutAttributes.md +docs/JsonApiOrgMemoryItemOutDocument.md +docs/JsonApiOrgMemoryItemOutList.md +docs/JsonApiOrgMemoryItemOutWithLinks.md +docs/JsonApiOrgMemoryItemPatch.md +docs/JsonApiOrgMemoryItemPatchAttributes.md +docs/JsonApiOrgMemoryItemPatchDocument.md docs/JsonApiOrganizationIn.md docs/JsonApiOrganizationInAttributes.md docs/JsonApiOrganizationInDocument.md @@ -1058,6 +1095,14 @@ docs/JsonApiWorkspaceAutomationOutList.md docs/JsonApiWorkspaceAutomationOutRelationships.md docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md docs/JsonApiWorkspaceAutomationOutWithLinks.md +docs/JsonApiWorkspaceColorPaletteIn.md +docs/JsonApiWorkspaceColorPaletteInDocument.md +docs/JsonApiWorkspaceColorPaletteOut.md +docs/JsonApiWorkspaceColorPaletteOutDocument.md +docs/JsonApiWorkspaceColorPaletteOutList.md +docs/JsonApiWorkspaceColorPaletteOutWithLinks.md +docs/JsonApiWorkspaceColorPalettePatch.md +docs/JsonApiWorkspaceColorPalettePatchDocument.md docs/JsonApiWorkspaceDataFilterIn.md docs/JsonApiWorkspaceDataFilterInAttributes.md docs/JsonApiWorkspaceDataFilterInDocument.md @@ -1085,6 +1130,20 @@ docs/JsonApiWorkspaceDataFilterSettingPatchDocument.md docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md docs/JsonApiWorkspaceDataFilterToManyLinkage.md docs/JsonApiWorkspaceDataFilterToOneLinkage.md +docs/JsonApiWorkspaceExportTemplateIn.md +docs/JsonApiWorkspaceExportTemplateInAttributes.md +docs/JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md +docs/JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.md +docs/JsonApiWorkspaceExportTemplateInDocument.md +docs/JsonApiWorkspaceExportTemplateOut.md +docs/JsonApiWorkspaceExportTemplateOutDocument.md +docs/JsonApiWorkspaceExportTemplateOutList.md +docs/JsonApiWorkspaceExportTemplateOutWithLinks.md +docs/JsonApiWorkspaceExportTemplatePatch.md +docs/JsonApiWorkspaceExportTemplatePatchAttributes.md +docs/JsonApiWorkspaceExportTemplatePatchDocument.md +docs/JsonApiWorkspaceExportTemplatePostOptionalId.md +docs/JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md docs/JsonApiWorkspaceIn.md docs/JsonApiWorkspaceInAttributes.md docs/JsonApiWorkspaceInAttributesDataSource.md @@ -1092,6 +1151,7 @@ docs/JsonApiWorkspaceInDocument.md docs/JsonApiWorkspaceInRelationships.md docs/JsonApiWorkspaceLinkage.md docs/JsonApiWorkspaceOut.md +docs/JsonApiWorkspaceOutAttributes.md docs/JsonApiWorkspaceOutDocument.md docs/JsonApiWorkspaceOutList.md docs/JsonApiWorkspaceOutMeta.md @@ -1111,6 +1171,14 @@ docs/JsonApiWorkspaceSettingPatch.md docs/JsonApiWorkspaceSettingPatchDocument.md docs/JsonApiWorkspaceSettingPostOptionalId.md docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md +docs/JsonApiWorkspaceThemeIn.md +docs/JsonApiWorkspaceThemeInDocument.md +docs/JsonApiWorkspaceThemeOut.md +docs/JsonApiWorkspaceThemeOutDocument.md +docs/JsonApiWorkspaceThemeOutList.md +docs/JsonApiWorkspaceThemeOutWithLinks.md +docs/JsonApiWorkspaceThemePatch.md +docs/JsonApiWorkspaceThemePatchDocument.md docs/JsonApiWorkspaceToOneLinkage.md docs/JsonNode.md docs/JwkControllerApi.md @@ -1135,19 +1203,18 @@ docs/LdmObjectPermissionsForAssigneeRule.md docs/ListLinks.md docs/ListLinksAllOf.md docs/ListLlmProviderModelsRequest.md -docs/ListLlmProviderModelsRequestProviderConfig.md docs/ListLlmProviderModelsResponse.md docs/LiveFeatureFlagConfiguration.md docs/LiveFeatures.md docs/LiveFeaturesAllOf.md docs/LlmModel.md -docs/LlmProviderAuth.md docs/LlmProviderConfig.md docs/LlmProviderControllerApi.md docs/LocalIdentifier.md docs/LocaleRequest.md docs/ManageAttributePermissionsRequestInner.md docs/ManageDashboardPermissionsRequestInner.md +docs/ManageMetricPermissionsRequestInner.md docs/ManagePermissionsApi.md docs/MatchAttributeFilter.md docs/MatchAttributeFilterMatchAttributeFilter.md @@ -1157,17 +1224,19 @@ docs/MeasureExecutionResultHeader.md docs/MeasureGroupHeaders.md docs/MeasureHeader.md docs/MeasureItem.md -docs/MeasureItemDefinition.md docs/MeasureResultHeader.md docs/MeasureValueCondition.md docs/MeasureValueFilter.md docs/MemoryItemControllerApi.md docs/MemoryItemCreatedByUsers.md docs/MemoryItemUser.md -docs/MetadataSyncApi.md docs/Metric.md docs/MetricControllerApi.md docs/MetricDefinitionOverride.md +docs/MetricPermissions.md +docs/MetricPermissionsAssignment.md +docs/MetricPermissionsForAssignee.md +docs/MetricPermissionsForAssigneeRule.md docs/MetricRecord.md docs/MetricValueChange.md docs/MetricsApi.md @@ -1184,6 +1253,7 @@ docs/NotificationChannelsApi.md docs/NotificationContent.md docs/NotificationData.md docs/NotificationFilter.md +docs/NotificationParameter.md docs/Notifications.md docs/NotificationsMeta.md docs/NotificationsMetaTotal.md @@ -1203,6 +1273,7 @@ docs/OpenTelemetryService.md docs/Operation.md docs/OperationError.md docs/OptionsApi.md +docs/OrgMemoryItemControllerApi.md docs/OrganizationAutomationIdentifier.md docs/OrganizationAutomationManagementBulkRequest.md docs/OrganizationCacheSettings.md @@ -1223,6 +1294,7 @@ docs/Parameter.md docs/ParameterControllerApi.md docs/ParameterDefinition.md docs/ParameterItem.md +docs/ParameterValue.md docs/ParametersApi.md docs/PartitionConfig.md docs/PdfTableStyle.md @@ -1235,9 +1307,6 @@ docs/PermissionsAssignment.md docs/PermissionsForAssignee.md docs/PermissionsForAssigneeRule.md docs/PipeTable.md -docs/PipeTableDistributionConfig.md -docs/PipeTableKeyConfig.md -docs/PipeTablePartitionConfig.md docs/PipeTableSummary.md docs/PlatformUsage.md docs/PlatformUsageRequest.md @@ -1313,6 +1382,7 @@ docs/ScanResultPdm.md docs/ScanSqlRequest.md docs/ScanSqlResponse.md docs/ScanningApi.md +docs/ScheduleCacheRetention.md docs/SearchRelationshipObject.md docs/SearchRequest.md docs/SearchResult.md @@ -1344,6 +1414,7 @@ docs/SqlQueryAllOf.md docs/StaticFeatures.md docs/StaticFeaturesAllOf.md docs/StringConstraints.md +docs/StringParameterAllowedValue.md docs/StringParameterDefinition.md docs/SucceededOperation.md docs/SucceededOperationAllOf.md @@ -1358,6 +1429,7 @@ docs/TableStatisticsResponse.md docs/TableStatisticsWarning.md docs/TableWarning.md docs/TabularExportApi.md +docs/TabularExportExecution.md docs/TabularExportRequest.md docs/TelemetryConfig.md docs/TelemetryContext.md @@ -1422,6 +1494,7 @@ docs/UserSettingsApi.md docs/UsersDeclarativeAPIsApi.md docs/UsersEntityAPIsApi.md docs/ValidateByItem.md +docs/ValidityPeriodCacheRetention.md docs/Value.md docs/VisibleFilter.md docs/VisualExportApi.md @@ -1449,18 +1522,23 @@ docs/WorkspaceAutomationIdentifier.md docs/WorkspaceAutomationManagementBulkRequest.md docs/WorkspaceCacheSettings.md docs/WorkspaceCacheUsage.md +docs/WorkspaceColorPaletteControllerApi.md docs/WorkspaceControllerApi.md docs/WorkspaceCurrentCacheUsage.md +docs/WorkspaceDashboardSlidesTemplate.md docs/WorkspaceDataFilterControllerApi.md docs/WorkspaceDataFilterSettingControllerApi.md docs/WorkspaceDataSource.md +docs/WorkspaceExportTemplateControllerApi.md docs/WorkspaceIdentifier.md docs/WorkspacePermissionAssignment.md docs/WorkspaceSettingControllerApi.md +docs/WorkspaceThemeControllerApi.md docs/WorkspaceUser.md docs/WorkspaceUserGroup.md docs/WorkspaceUserGroups.md docs/WorkspaceUsers.md +docs/WorkspaceWidgetSlidesTemplate.md docs/WorkspacesDeclarativeAPIsApi.md docs/WorkspacesEntityAPIsApi.md docs/WorkspacesSettingsApi.md @@ -1476,6 +1554,7 @@ gooddata_api_client/api/ai_lake_api.py gooddata_api_client/api/ai_lake_databases_api.py gooddata_api_client/api/ai_lake_pipe_tables_api.py gooddata_api_client/api/ai_lake_services_operations_api.py +gooddata_api_client/api/ai_observability_api.py gooddata_api_client/api/analytical_dashboard_controller_api.py gooddata_api_client/api/analytics_model_api.py gooddata_api_client/api/api_token_controller_api.py @@ -1532,6 +1611,8 @@ gooddata_api_client/api/filter_context_api.py gooddata_api_client/api/filter_context_controller_api.py gooddata_api_client/api/filter_view_controller_api.py gooddata_api_client/api/filter_views_api.py +gooddata_api_client/api/fiscal_calendar_controller_api.py +gooddata_api_client/api/fiscal_calendars_api.py gooddata_api_client/api/generate_logical_data_model_api.py gooddata_api_client/api/geographic_data_api.py gooddata_api_client/api/hierarchy_api.py @@ -1552,7 +1633,6 @@ gooddata_api_client/api/llm_provider_controller_api.py gooddata_api_client/api/llm_providers_api.py gooddata_api_client/api/manage_permissions_api.py gooddata_api_client/api/memory_item_controller_api.py -gooddata_api_client/api/metadata_sync_api.py gooddata_api_client/api/metric_controller_api.py gooddata_api_client/api/metrics_api.py gooddata_api_client/api/notification_channel_controller_api.py @@ -1560,6 +1640,7 @@ gooddata_api_client/api/notification_channel_identifier_controller_api.py gooddata_api_client/api/notification_channels_api.py gooddata_api_client/api/ogcapi_features_api.py gooddata_api_client/api/options_api.py +gooddata_api_client/api/org_memory_item_controller_api.py gooddata_api_client/api/organization_declarative_apis_api.py gooddata_api_client/api/organization_entity_apis_api.py gooddata_api_client/api/organization_entity_controller_api.py @@ -1595,10 +1676,13 @@ gooddata_api_client/api/users_entity_apis_api.py gooddata_api_client/api/visual_export_api.py gooddata_api_client/api/visualization_object_api.py gooddata_api_client/api/visualization_object_controller_api.py +gooddata_api_client/api/workspace_color_palette_controller_api.py gooddata_api_client/api/workspace_controller_api.py gooddata_api_client/api/workspace_data_filter_controller_api.py gooddata_api_client/api/workspace_data_filter_setting_controller_api.py +gooddata_api_client/api/workspace_export_template_controller_api.py gooddata_api_client/api/workspace_setting_controller_api.py +gooddata_api_client/api/workspace_theme_controller_api.py gooddata_api_client/api/workspaces_declarative_apis_api.py gooddata_api_client/api/workspaces_entity_apis_api.py gooddata_api_client/api/workspaces_settings_api.py @@ -1609,6 +1693,8 @@ gooddata_api_client/exceptions.py gooddata_api_client/model/__init__.py gooddata_api_client/model/absolute_date_filter.py gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py +gooddata_api_client/model/absolute_granularity_date_filter.py +gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py gooddata_api_client/model/abstract_measure_value_filter.py gooddata_api_client/model/active_object_identification.py gooddata_api_client/model/ad_hoc_automation.py @@ -1618,7 +1704,6 @@ gooddata_api_client/model/afm.py gooddata_api_client/model/afm_cancel_tokens.py gooddata_api_client/model/afm_execution.py gooddata_api_client/model/afm_execution_response.py -gooddata_api_client/model/afm_filters_inner.py gooddata_api_client/model/afm_identifier.py gooddata_api_client/model/afm_local_identifier.py gooddata_api_client/model/afm_object_identifier.py @@ -1691,7 +1776,6 @@ gooddata_api_client/model/attribute_positive_filter.py gooddata_api_client/model/attribute_positive_filter_all_of.py gooddata_api_client/model/attribute_result_header.py gooddata_api_client/model/automation_alert.py -gooddata_api_client/model/automation_alert_condition.py gooddata_api_client/model/automation_dashboard_tabular_export.py gooddata_api_client/model/automation_external_recipient.py gooddata_api_client/model/automation_image_export.py @@ -1714,9 +1798,14 @@ gooddata_api_client/model/azure_foundry_provider_config.py gooddata_api_client/model/bedrock_provider_auth.py gooddata_api_client/model/bounded_filter.py gooddata_api_client/model/cache_removal_interval.py +gooddata_api_client/model/cache_retention.py +gooddata_api_client/model/cache_retention_schedule.py gooddata_api_client/model/cache_usage_data.py +gooddata_api_client/model/calendar_definition.py +gooddata_api_client/model/calendar_granularity.py +gooddata_api_client/model/calendar_table_reference.py +gooddata_api_client/model/certification_info.py gooddata_api_client/model/change_analysis_params.py -gooddata_api_client/model/change_analysis_params_filters_inner.py gooddata_api_client/model/change_analysis_request.py gooddata_api_client/model/change_analysis_response.py gooddata_api_client/model/change_analysis_result.py @@ -1754,6 +1843,9 @@ gooddata_api_client/model/convert_geo_file_request.py gooddata_api_client/model/convert_geo_file_response.py gooddata_api_client/model/cover_slide_template.py gooddata_api_client/model/create_pipe_table_request.py +gooddata_api_client/model/create_pipe_table_request_distribution_config.py +gooddata_api_client/model/create_pipe_table_request_key_config.py +gooddata_api_client/model/create_pipe_table_request_partition_config.py gooddata_api_client/model/created_visualization.py gooddata_api_client/model/created_visualization_filters_inner.py gooddata_api_client/model/created_visualizations.py @@ -1762,6 +1854,8 @@ gooddata_api_client/model/csv_convert_options_column_type.py gooddata_api_client/model/csv_manifest_body.py gooddata_api_client/model/csv_parse_options.py gooddata_api_client/model/csv_read_options.py +gooddata_api_client/model/custom_calendar_definition.py +gooddata_api_client/model/custom_calendar_definition_all_of.py gooddata_api_client/model/custom_label.py gooddata_api_client/model/custom_metric.py gooddata_api_client/model/custom_override.py @@ -1784,7 +1878,6 @@ gooddata_api_client/model/dashboard_match_attribute_filter.py gooddata_api_client/model/dashboard_match_attribute_filter_match_attribute_filter.py gooddata_api_client/model/dashboard_measure_value_filter.py gooddata_api_client/model/dashboard_measure_value_filter_dashboard_measure_value_filter.py -gooddata_api_client/model/dashboard_parameter_value.py gooddata_api_client/model/dashboard_permissions.py gooddata_api_client/model/dashboard_permissions_assignment.py gooddata_api_client/model/dashboard_slides_template.py @@ -1827,6 +1920,7 @@ gooddata_api_client/model/declarative_analytics_layer.py gooddata_api_client/model/declarative_attribute.py gooddata_api_client/model/declarative_attribute_hierarchy.py gooddata_api_client/model/declarative_automation.py +gooddata_api_client/model/declarative_calendar.py gooddata_api_client/model/declarative_color_palette.py gooddata_api_client/model/declarative_column.py gooddata_api_client/model/declarative_csp_directive.py @@ -1844,7 +1938,6 @@ gooddata_api_client/model/declarative_dataset_sql.py gooddata_api_client/model/declarative_date_dataset.py gooddata_api_client/model/declarative_export_definition.py gooddata_api_client/model/declarative_export_definition_identifier.py -gooddata_api_client/model/declarative_export_definition_request_payload.py gooddata_api_client/model/declarative_export_template.py gooddata_api_client/model/declarative_export_templates.py gooddata_api_client/model/declarative_fact.py @@ -1862,14 +1955,12 @@ gooddata_api_client/model/declarative_memory_item.py gooddata_api_client/model/declarative_metric.py gooddata_api_client/model/declarative_model.py gooddata_api_client/model/declarative_notification_channel.py -gooddata_api_client/model/declarative_notification_channel_destination.py gooddata_api_client/model/declarative_notification_channel_identifier.py gooddata_api_client/model/declarative_notification_channels.py gooddata_api_client/model/declarative_organization.py gooddata_api_client/model/declarative_organization_info.py gooddata_api_client/model/declarative_organization_permission.py gooddata_api_client/model/declarative_parameter.py -gooddata_api_client/model/declarative_parameter_content.py gooddata_api_client/model/declarative_reference.py gooddata_api_client/model/declarative_reference_source.py gooddata_api_client/model/declarative_rsa_specification.py @@ -1894,14 +1985,17 @@ 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_workspace.py +gooddata_api_client/model/declarative_workspace_color_palette.py gooddata_api_client/model/declarative_workspace_data_filter.py gooddata_api_client/model/declarative_workspace_data_filter_column.py gooddata_api_client/model/declarative_workspace_data_filter_references.py gooddata_api_client/model/declarative_workspace_data_filter_setting.py gooddata_api_client/model/declarative_workspace_data_filters.py +gooddata_api_client/model/declarative_workspace_export_template.py gooddata_api_client/model/declarative_workspace_hierarchy_permission.py gooddata_api_client/model/declarative_workspace_model.py gooddata_api_client/model/declarative_workspace_permissions.py +gooddata_api_client/model/declarative_workspace_theme.py gooddata_api_client/model/declarative_workspaces.py gooddata_api_client/model/default_smtp.py gooddata_api_client/model/default_smtp_all_of.py @@ -1954,6 +2048,8 @@ gooddata_api_client/model/filter.py gooddata_api_client/model/filter_by.py gooddata_api_client/model/filter_definition.py gooddata_api_client/model/filter_definition_for_simple_measure.py +gooddata_api_client/model/fiscal_year_calendar_definition.py +gooddata_api_client/model/fiscal_year_calendar_definition_all_of.py gooddata_api_client/model/forecast_config.py gooddata_api_client/model/forecast_request.py gooddata_api_client/model/forecast_result.py @@ -1962,6 +2058,8 @@ gooddata_api_client/model/frequency.py gooddata_api_client/model/frequency_bucket.py gooddata_api_client/model/frequency_properties.py gooddata_api_client/model/gd_storage_file.py +gooddata_api_client/model/gen_ai_ranking_filter.py +gooddata_api_client/model/gen_ai_ranking_filter_all_of.py gooddata_api_client/model/generate_description_request.py gooddata_api_client/model/generate_description_response.py gooddata_api_client/model/generate_ldm_request.py @@ -1998,6 +2096,7 @@ gooddata_api_client/model/import_geo_collection_request.py gooddata_api_client/model/import_geo_collection_response.py gooddata_api_client/model/in_platform.py gooddata_api_client/model/in_platform_all_of.py +gooddata_api_client/model/indefinite_cache_retention.py gooddata_api_client/model/inline_filter_definition.py gooddata_api_client/model/inline_filter_definition_inline.py gooddata_api_client/model/inline_measure_definition.py @@ -2219,6 +2318,7 @@ gooddata_api_client/model/json_api_data_source_identifier_out_meta.py gooddata_api_client/model/json_api_data_source_identifier_out_with_links.py gooddata_api_client/model/json_api_data_source_in.py gooddata_api_client/model/json_api_data_source_in_attributes.py +gooddata_api_client/model/json_api_data_source_in_attributes_cache_retention.py gooddata_api_client/model/json_api_data_source_in_attributes_parameters_inner.py gooddata_api_client/model/json_api_data_source_in_document.py gooddata_api_client/model/json_api_data_source_out.py @@ -2329,6 +2429,13 @@ gooddata_api_client/model/json_api_filter_view_out_with_links.py gooddata_api_client/model/json_api_filter_view_patch.py gooddata_api_client/model/json_api_filter_view_patch_attributes.py gooddata_api_client/model/json_api_filter_view_patch_document.py +gooddata_api_client/model/json_api_fiscal_calendar_out.py +gooddata_api_client/model/json_api_fiscal_calendar_out_attributes.py +gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_definition.py +gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_enabled_granularities_inner.py +gooddata_api_client/model/json_api_fiscal_calendar_out_document.py +gooddata_api_client/model/json_api_fiscal_calendar_out_list.py +gooddata_api_client/model/json_api_fiscal_calendar_out_with_links.py gooddata_api_client/model/json_api_identity_provider_in.py gooddata_api_client/model/json_api_identity_provider_in_attributes.py gooddata_api_client/model/json_api_identity_provider_in_document.py @@ -2466,6 +2573,17 @@ gooddata_api_client/model/json_api_notification_channel_patch_document.py gooddata_api_client/model/json_api_notification_channel_post_optional_id.py gooddata_api_client/model/json_api_notification_channel_post_optional_id_document.py gooddata_api_client/model/json_api_notification_channel_to_one_linkage.py +gooddata_api_client/model/json_api_org_memory_item_in.py +gooddata_api_client/model/json_api_org_memory_item_in_attributes.py +gooddata_api_client/model/json_api_org_memory_item_in_document.py +gooddata_api_client/model/json_api_org_memory_item_out.py +gooddata_api_client/model/json_api_org_memory_item_out_attributes.py +gooddata_api_client/model/json_api_org_memory_item_out_document.py +gooddata_api_client/model/json_api_org_memory_item_out_list.py +gooddata_api_client/model/json_api_org_memory_item_out_with_links.py +gooddata_api_client/model/json_api_org_memory_item_patch.py +gooddata_api_client/model/json_api_org_memory_item_patch_attributes.py +gooddata_api_client/model/json_api_org_memory_item_patch_document.py gooddata_api_client/model/json_api_organization_in.py gooddata_api_client/model/json_api_organization_in_attributes.py gooddata_api_client/model/json_api_organization_in_document.py @@ -2591,6 +2709,14 @@ gooddata_api_client/model/json_api_workspace_automation_out_list.py gooddata_api_client/model/json_api_workspace_automation_out_relationships.py gooddata_api_client/model/json_api_workspace_automation_out_relationships_workspace.py gooddata_api_client/model/json_api_workspace_automation_out_with_links.py +gooddata_api_client/model/json_api_workspace_color_palette_in.py +gooddata_api_client/model/json_api_workspace_color_palette_in_document.py +gooddata_api_client/model/json_api_workspace_color_palette_out.py +gooddata_api_client/model/json_api_workspace_color_palette_out_document.py +gooddata_api_client/model/json_api_workspace_color_palette_out_list.py +gooddata_api_client/model/json_api_workspace_color_palette_out_with_links.py +gooddata_api_client/model/json_api_workspace_color_palette_patch.py +gooddata_api_client/model/json_api_workspace_color_palette_patch_document.py gooddata_api_client/model/json_api_workspace_data_filter_in.py gooddata_api_client/model/json_api_workspace_data_filter_in_attributes.py gooddata_api_client/model/json_api_workspace_data_filter_in_document.py @@ -2618,6 +2744,20 @@ gooddata_api_client/model/json_api_workspace_data_filter_setting_patch_document. gooddata_api_client/model/json_api_workspace_data_filter_setting_to_many_linkage.py gooddata_api_client/model/json_api_workspace_data_filter_to_many_linkage.py gooddata_api_client/model/json_api_workspace_data_filter_to_one_linkage.py +gooddata_api_client/model/json_api_workspace_export_template_in.py +gooddata_api_client/model/json_api_workspace_export_template_in_attributes.py +gooddata_api_client/model/json_api_workspace_export_template_in_attributes_dashboard_slides_template.py +gooddata_api_client/model/json_api_workspace_export_template_in_attributes_widget_slides_template.py +gooddata_api_client/model/json_api_workspace_export_template_in_document.py +gooddata_api_client/model/json_api_workspace_export_template_out.py +gooddata_api_client/model/json_api_workspace_export_template_out_document.py +gooddata_api_client/model/json_api_workspace_export_template_out_list.py +gooddata_api_client/model/json_api_workspace_export_template_out_with_links.py +gooddata_api_client/model/json_api_workspace_export_template_patch.py +gooddata_api_client/model/json_api_workspace_export_template_patch_attributes.py +gooddata_api_client/model/json_api_workspace_export_template_patch_document.py +gooddata_api_client/model/json_api_workspace_export_template_post_optional_id.py +gooddata_api_client/model/json_api_workspace_export_template_post_optional_id_document.py gooddata_api_client/model/json_api_workspace_in.py gooddata_api_client/model/json_api_workspace_in_attributes.py gooddata_api_client/model/json_api_workspace_in_attributes_data_source.py @@ -2625,6 +2765,7 @@ gooddata_api_client/model/json_api_workspace_in_document.py gooddata_api_client/model/json_api_workspace_in_relationships.py gooddata_api_client/model/json_api_workspace_linkage.py gooddata_api_client/model/json_api_workspace_out.py +gooddata_api_client/model/json_api_workspace_out_attributes.py gooddata_api_client/model/json_api_workspace_out_document.py gooddata_api_client/model/json_api_workspace_out_list.py gooddata_api_client/model/json_api_workspace_out_meta.py @@ -2644,6 +2785,14 @@ gooddata_api_client/model/json_api_workspace_setting_patch.py gooddata_api_client/model/json_api_workspace_setting_patch_document.py gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py gooddata_api_client/model/json_api_workspace_setting_post_optional_id_document.py +gooddata_api_client/model/json_api_workspace_theme_in.py +gooddata_api_client/model/json_api_workspace_theme_in_document.py +gooddata_api_client/model/json_api_workspace_theme_out.py +gooddata_api_client/model/json_api_workspace_theme_out_document.py +gooddata_api_client/model/json_api_workspace_theme_out_list.py +gooddata_api_client/model/json_api_workspace_theme_out_with_links.py +gooddata_api_client/model/json_api_workspace_theme_patch.py +gooddata_api_client/model/json_api_workspace_theme_patch_document.py gooddata_api_client/model/json_api_workspace_to_one_linkage.py gooddata_api_client/model/json_node.py gooddata_api_client/model/key_config.py @@ -2660,18 +2809,17 @@ gooddata_api_client/model/ldm_object_permissions_for_assignee_rule.py gooddata_api_client/model/list_links.py gooddata_api_client/model/list_links_all_of.py gooddata_api_client/model/list_llm_provider_models_request.py -gooddata_api_client/model/list_llm_provider_models_request_provider_config.py gooddata_api_client/model/list_llm_provider_models_response.py gooddata_api_client/model/live_feature_flag_configuration.py gooddata_api_client/model/live_features.py gooddata_api_client/model/live_features_all_of.py gooddata_api_client/model/llm_model.py -gooddata_api_client/model/llm_provider_auth.py gooddata_api_client/model/llm_provider_config.py gooddata_api_client/model/local_identifier.py gooddata_api_client/model/locale_request.py gooddata_api_client/model/manage_attribute_permissions_request_inner.py gooddata_api_client/model/manage_dashboard_permissions_request_inner.py +gooddata_api_client/model/manage_metric_permissions_request_inner.py gooddata_api_client/model/match_attribute_filter.py gooddata_api_client/model/match_attribute_filter_match_attribute_filter.py gooddata_api_client/model/matomo_service.py @@ -2680,7 +2828,6 @@ gooddata_api_client/model/measure_execution_result_header.py gooddata_api_client/model/measure_group_headers.py gooddata_api_client/model/measure_header.py gooddata_api_client/model/measure_item.py -gooddata_api_client/model/measure_item_definition.py gooddata_api_client/model/measure_result_header.py gooddata_api_client/model/measure_value_condition.py gooddata_api_client/model/measure_value_filter.py @@ -2688,6 +2835,10 @@ gooddata_api_client/model/memory_item_created_by_users.py gooddata_api_client/model/memory_item_user.py gooddata_api_client/model/metric.py gooddata_api_client/model/metric_definition_override.py +gooddata_api_client/model/metric_permissions.py +gooddata_api_client/model/metric_permissions_assignment.py +gooddata_api_client/model/metric_permissions_for_assignee.py +gooddata_api_client/model/metric_permissions_for_assignee_rule.py gooddata_api_client/model/metric_record.py gooddata_api_client/model/metric_value_change.py gooddata_api_client/model/model_test_result.py @@ -2700,6 +2851,7 @@ gooddata_api_client/model/notification_channel_destination.py gooddata_api_client/model/notification_content.py gooddata_api_client/model/notification_data.py gooddata_api_client/model/notification_filter.py +gooddata_api_client/model/notification_parameter.py gooddata_api_client/model/notifications.py gooddata_api_client/model/notifications_meta.py gooddata_api_client/model/notifications_meta_total.py @@ -2732,6 +2884,7 @@ gooddata_api_client/model/paging.py 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/partition_config.py gooddata_api_client/model/pdf_table_style.py gooddata_api_client/model/pdf_table_style_property.py @@ -2742,9 +2895,6 @@ gooddata_api_client/model/permissions_assignment.py gooddata_api_client/model/permissions_for_assignee.py gooddata_api_client/model/permissions_for_assignee_rule.py gooddata_api_client/model/pipe_table.py -gooddata_api_client/model/pipe_table_distribution_config.py -gooddata_api_client/model/pipe_table_key_config.py -gooddata_api_client/model/pipe_table_partition_config.py gooddata_api_client/model/pipe_table_summary.py gooddata_api_client/model/platform_usage.py gooddata_api_client/model/platform_usage_request.py @@ -2816,6 +2966,7 @@ gooddata_api_client/model/scan_request.py gooddata_api_client/model/scan_result_pdm.py gooddata_api_client/model/scan_sql_request.py gooddata_api_client/model/scan_sql_response.py +gooddata_api_client/model/schedule_cache_retention.py gooddata_api_client/model/search_relationship_object.py gooddata_api_client/model/search_request.py gooddata_api_client/model/search_result.py @@ -2845,6 +2996,7 @@ gooddata_api_client/model/sql_query_all_of.py gooddata_api_client/model/static_features.py gooddata_api_client/model/static_features_all_of.py gooddata_api_client/model/string_constraints.py +gooddata_api_client/model/string_parameter_allowed_value.py gooddata_api_client/model/string_parameter_definition.py gooddata_api_client/model/succeeded_operation.py gooddata_api_client/model/succeeded_operation_all_of.py @@ -2858,6 +3010,7 @@ gooddata_api_client/model/table_statistics_request.py gooddata_api_client/model/table_statistics_response.py gooddata_api_client/model/table_statistics_warning.py gooddata_api_client/model/table_warning.py +gooddata_api_client/model/tabular_export_execution.py gooddata_api_client/model/tabular_export_request.py gooddata_api_client/model/telemetry_config.py gooddata_api_client/model/telemetry_context.py @@ -2904,6 +3057,7 @@ 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/validity_period_cache_retention.py gooddata_api_client/model/value.py gooddata_api_client/model/visible_filter.py gooddata_api_client/model/visual_export_request.py @@ -2929,6 +3083,7 @@ gooddata_api_client/model/workspace_automation_management_bulk_request.py gooddata_api_client/model/workspace_cache_settings.py gooddata_api_client/model/workspace_cache_usage.py gooddata_api_client/model/workspace_current_cache_usage.py +gooddata_api_client/model/workspace_dashboard_slides_template.py gooddata_api_client/model/workspace_data_source.py gooddata_api_client/model/workspace_identifier.py gooddata_api_client/model/workspace_permission_assignment.py @@ -2936,6 +3091,7 @@ gooddata_api_client/model/workspace_user.py gooddata_api_client/model/workspace_user_group.py gooddata_api_client/model/workspace_user_groups.py gooddata_api_client/model/workspace_users.py +gooddata_api_client/model/workspace_widget_slides_template.py gooddata_api_client/model/xliff.py gooddata_api_client/model_utils.py gooddata_api_client/models/__init__.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 0884f4f5e..a5ef116e6 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -61,6 +61,10 @@ from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiM from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument # 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( @@ -132,20 +136,24 @@ Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AIApi* | [**create_entity_knowledge_recommendations**](docs/AIApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations *AIApi* | [**create_entity_memory_items**](docs/AIApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items +*AIApi* | [**create_entity_org_memory_items**](docs/AIApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities *AIApi* | [**delete_entity_knowledge_recommendations**](docs/AIApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation *AIApi* | [**delete_entity_memory_items**](docs/AIApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item +*AIApi* | [**delete_entity_org_memory_items**](docs/AIApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity *AIApi* | [**get_all_entities_knowledge_recommendations**](docs/AIApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations *AIApi* | [**get_all_entities_memory_items**](docs/AIApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items +*AIApi* | [**get_all_entities_org_memory_items**](docs/AIApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities *AIApi* | [**get_entity_knowledge_recommendations**](docs/AIApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation *AIApi* | [**get_entity_memory_items**](docs/AIApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item -*AIApi* | [**metadata_sync**](docs/AIApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -*AIApi* | [**metadata_sync_organization**](docs/AIApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services +*AIApi* | [**get_entity_org_memory_items**](docs/AIApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity *AIApi* | [**patch_entity_knowledge_recommendations**](docs/AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation *AIApi* | [**patch_entity_memory_items**](docs/AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item +*AIApi* | [**patch_entity_org_memory_items**](docs/AIApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity *AIApi* | [**search_entities_knowledge_recommendations**](docs/AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) *AIApi* | [**search_entities_memory_items**](docs/AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) *AIApi* | [**update_entity_knowledge_recommendations**](docs/AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation *AIApi* | [**update_entity_memory_items**](docs/AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item +*AIApi* | [**update_entity_org_memory_items**](docs/AIApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity *AIAgentsApi* | [**create_entity_agents**](docs/AIAgentsApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities *AIAgentsApi* | [**delete_entity_agents**](docs/AIAgentsApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity *AIAgentsApi* | [**get_all_entities_agents**](docs/AIAgentsApi.md#get_all_entities_agents) | **GET** /api/v1/entities/agents | Get all Agent entities @@ -190,6 +198,7 @@ Class | Method | HTTP request | Description *AILakeServicesOperationsApi* | [**get_ai_lake_service_status**](docs/AILakeServicesOperationsApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status *AILakeServicesOperationsApi* | [**list_ai_lake_services**](docs/AILakeServicesOperationsApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services *AILakeServicesOperationsApi* | [**run_ai_lake_service_command**](docs/AILakeServicesOperationsApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command +*AIObservabilityApi* | [**reload_observability_layout**](docs/AIObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout *APITokensApi* | [**create_entity_api_tokens**](docs/APITokensApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user *APITokensApi* | [**delete_entity_api_tokens**](docs/APITokensApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user *APITokensApi* | [**get_all_entities_api_tokens**](docs/APITokensApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user @@ -198,16 +207,28 @@ Class | Method | HTTP request | Description *AnalyticsModelApi* | [**set_analytics_model**](docs/AnalyticsModelApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model *AppearanceApi* | [**create_entity_color_palettes**](docs/AppearanceApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes *AppearanceApi* | [**create_entity_themes**](docs/AppearanceApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming +*AppearanceApi* | [**create_entity_workspace_color_palettes**](docs/AppearanceApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette +*AppearanceApi* | [**create_entity_workspace_themes**](docs/AppearanceApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme *AppearanceApi* | [**delete_entity_color_palettes**](docs/AppearanceApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette *AppearanceApi* | [**delete_entity_themes**](docs/AppearanceApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming +*AppearanceApi* | [**delete_entity_workspace_color_palettes**](docs/AppearanceApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette +*AppearanceApi* | [**delete_entity_workspace_themes**](docs/AppearanceApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme *AppearanceApi* | [**get_all_entities_color_palettes**](docs/AppearanceApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes *AppearanceApi* | [**get_all_entities_themes**](docs/AppearanceApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities +*AppearanceApi* | [**get_all_entities_workspace_color_palettes**](docs/AppearanceApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes +*AppearanceApi* | [**get_all_entities_workspace_themes**](docs/AppearanceApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes *AppearanceApi* | [**get_entity_color_palettes**](docs/AppearanceApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette *AppearanceApi* | [**get_entity_themes**](docs/AppearanceApi.md#get_entity_themes) | **GET** /api/v1/entities/themes/{id} | Get Theming +*AppearanceApi* | [**get_entity_workspace_color_palettes**](docs/AppearanceApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette +*AppearanceApi* | [**get_entity_workspace_themes**](docs/AppearanceApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme *AppearanceApi* | [**patch_entity_color_palettes**](docs/AppearanceApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette *AppearanceApi* | [**patch_entity_themes**](docs/AppearanceApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming +*AppearanceApi* | [**patch_entity_workspace_color_palettes**](docs/AppearanceApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette +*AppearanceApi* | [**patch_entity_workspace_themes**](docs/AppearanceApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme *AppearanceApi* | [**update_entity_color_palettes**](docs/AppearanceApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette *AppearanceApi* | [**update_entity_themes**](docs/AppearanceApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming +*AppearanceApi* | [**update_entity_workspace_color_palettes**](docs/AppearanceApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette +*AppearanceApi* | [**update_entity_workspace_themes**](docs/AppearanceApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme *AttributeHierarchiesApi* | [**create_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies *AttributeHierarchiesApi* | [**delete_entity_attribute_hierarchies**](docs/AttributeHierarchiesApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy *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 @@ -340,11 +361,17 @@ Class | Method | HTTP request | Description *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* | [**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 *ExportTemplatesApi* | [**delete_entity_export_templates**](docs/ExportTemplatesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity +*ExportTemplatesApi* | [**delete_entity_workspace_export_templates**](docs/ExportTemplatesApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template *ExportTemplatesApi* | [**get_all_entities_export_templates**](docs/ExportTemplatesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities +*ExportTemplatesApi* | [**get_all_entities_workspace_export_templates**](docs/ExportTemplatesApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates *ExportTemplatesApi* | [**get_entity_export_templates**](docs/ExportTemplatesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity +*ExportTemplatesApi* | [**get_entity_workspace_export_templates**](docs/ExportTemplatesApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template *ExportTemplatesApi* | [**patch_entity_export_templates**](docs/ExportTemplatesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity +*ExportTemplatesApi* | [**patch_entity_workspace_export_templates**](docs/ExportTemplatesApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template *ExportTemplatesApi* | [**update_entity_export_templates**](docs/ExportTemplatesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity +*ExportTemplatesApi* | [**update_entity_workspace_export_templates**](docs/ExportTemplatesApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template *FactsApi* | [**get_all_entities_aggregated_facts**](docs/FactsApi.md#get_all_entities_aggregated_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/aggregatedFacts | Get all Aggregated Facts *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 @@ -368,6 +395,8 @@ Class | Method | HTTP request | Description *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* | [**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 +*FiscalCalendarsApi* | [**get_entity_fiscal_calendars**](docs/FiscalCalendarsApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar *GenerateLogicalDataModelApi* | [**generate_logical_model**](docs/GenerateLogicalDataModelApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) *GeographicDataApi* | [**create_entity_custom_geo_collections**](docs/GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections *GeographicDataApi* | [**delete_entity_custom_geo_collections**](docs/GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection @@ -420,8 +449,6 @@ Class | Method | HTTP request | Description *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. -*MetadataSyncApi* | [**metadata_sync**](docs/MetadataSyncApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -*MetadataSyncApi* | [**metadata_sync_organization**](docs/MetadataSyncApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services *MetricsApi* | [**create_entity_metrics**](docs/MetricsApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics *MetricsApi* | [**delete_entity_metrics**](docs/MetricsApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric *MetricsApi* | [**get_all_entities_metrics**](docs/MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics @@ -493,8 +520,10 @@ Class | Method | HTTP request | Description *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_organization_permissions**](docs/PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization *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* | [**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 @@ -526,8 +555,8 @@ Class | Method | HTTP request | Description *SmartFunctionsApi* | [**clustering**](docs/SmartFunctionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering *SmartFunctionsApi* | [**clustering_result**](docs/SmartFunctionsApi.md#clustering_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId} | (EXPERIMENTAL) Smart functions - Clustering Result *SmartFunctionsApi* | [**created_by**](docs/SmartFunctionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users -*SmartFunctionsApi* | [**forecast**](docs/SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast -*SmartFunctionsApi* | [**forecast_result**](docs/SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +*SmartFunctionsApi* | [**forecast**](docs/SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast +*SmartFunctionsApi* | [**forecast_result**](docs/SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result *SmartFunctionsApi* | [**generate_description**](docs/SmartFunctionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object *SmartFunctionsApi* | [**generate_title**](docs/SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object *SmartFunctionsApi* | [**get_quality_issues**](docs/SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues @@ -680,8 +709,8 @@ Class | Method | HTTP request | Description *ActionsApi* | [**delete_workspace_automations**](docs/ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace *ActionsApi* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. *ActionsApi* | [**fact_permissions**](docs/ActionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions -*ActionsApi* | [**forecast**](docs/ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast -*ActionsApi* | [**forecast_result**](docs/ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +*ActionsApi* | [**forecast**](docs/ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast +*ActionsApi* | [**forecast_result**](docs/ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result *ActionsApi* | [**generate_dashboard_summary**](docs/ActionsApi.md#generate_dashboard_summary) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary | *ActionsApi* | [**generate_description**](docs/ActionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object *ActionsApi* | [**generate_logical_model**](docs/ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) @@ -719,13 +748,13 @@ Class | Method | HTTP request | Description *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_organization_permissions**](docs/ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization *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* | [**metadata_sync**](docs/ActionsApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -*ActionsApi* | [**metadata_sync_organization**](docs/ActionsApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services +*ActionsApi* | [**metric_permissions**](docs/ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions *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. @@ -735,6 +764,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**read_csv_file_manifests**](docs/ActionsApi.md#read_csv_file_manifests) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests | Read CSV file manifests *ActionsApi* | [**register_upload_notification**](docs/ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification *ActionsApi* | [**register_workspace_upload_notification**](docs/ActionsApi.md#register_workspace_upload_notification) | **POST** /api/v1/actions/workspaces/{workspaceId}/uploadNotification | Register an upload notification +*ActionsApi* | [**reload_observability_layout**](docs/ActionsApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout *ActionsApi* | [**remove_targets**](docs/ActionsApi.md#remove_targets) | **POST** /api/v1/actions/ipAllowlistPolicies/{id}/removeTargets | Remove targets from IP allowlist policy *ActionsApi* | [**resolve_all_entitlements**](docs/ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. *ActionsApi* | [**resolve_all_settings_without_workspace**](docs/ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. @@ -893,6 +923,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_memory_items**](docs/EntitiesApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items *EntitiesApi* | [**create_entity_metrics**](docs/EntitiesApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics *EntitiesApi* | [**create_entity_notification_channels**](docs/EntitiesApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities +*EntitiesApi* | [**create_entity_org_memory_items**](docs/EntitiesApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities *EntitiesApi* | [**create_entity_organization_settings**](docs/EntitiesApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities *EntitiesApi* | [**create_entity_parameters**](docs/EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters *EntitiesApi* | [**create_entity_themes**](docs/EntitiesApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming @@ -901,9 +932,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_user_settings**](docs/EntitiesApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user *EntitiesApi* | [**create_entity_users**](docs/EntitiesApi.md#create_entity_users) | **POST** /api/v1/entities/users | Post User entities *EntitiesApi* | [**create_entity_visualization_objects**](docs/EntitiesApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects +*EntitiesApi* | [**create_entity_workspace_color_palettes**](docs/EntitiesApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette *EntitiesApi* | [**create_entity_workspace_data_filter_settings**](docs/EntitiesApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters *EntitiesApi* | [**create_entity_workspace_data_filters**](docs/EntitiesApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters +*EntitiesApi* | [**create_entity_workspace_export_templates**](docs/EntitiesApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template *EntitiesApi* | [**create_entity_workspace_settings**](docs/EntitiesApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces +*EntitiesApi* | [**create_entity_workspace_themes**](docs/EntitiesApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme *EntitiesApi* | [**create_entity_workspaces**](docs/EntitiesApi.md#create_entity_workspaces) | **POST** /api/v1/entities/workspaces | Post Workspace entities *EntitiesApi* | [**delete_entity**](docs/EntitiesApi.md#delete_entity) | **DELETE** /api/v1/entities/llmEndpoints/{id} | Delete LLM endpoint entity (Removed) *EntitiesApi* | [**delete_entity_agents**](docs/EntitiesApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity @@ -930,6 +964,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_memory_items**](docs/EntitiesApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item *EntitiesApi* | [**delete_entity_metrics**](docs/EntitiesApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric *EntitiesApi* | [**delete_entity_notification_channels**](docs/EntitiesApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity +*EntitiesApi* | [**delete_entity_org_memory_items**](docs/EntitiesApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity *EntitiesApi* | [**delete_entity_organization_settings**](docs/EntitiesApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization Setting entity *EntitiesApi* | [**delete_entity_parameters**](docs/EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter *EntitiesApi* | [**delete_entity_themes**](docs/EntitiesApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming @@ -938,9 +973,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_user_settings**](docs/EntitiesApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user *EntitiesApi* | [**delete_entity_users**](docs/EntitiesApi.md#delete_entity_users) | **DELETE** /api/v1/entities/users/{id} | Delete User entity *EntitiesApi* | [**delete_entity_visualization_objects**](docs/EntitiesApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object +*EntitiesApi* | [**delete_entity_workspace_color_palettes**](docs/EntitiesApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette *EntitiesApi* | [**delete_entity_workspace_data_filter_settings**](docs/EntitiesApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter *EntitiesApi* | [**delete_entity_workspace_data_filters**](docs/EntitiesApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter +*EntitiesApi* | [**delete_entity_workspace_export_templates**](docs/EntitiesApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template *EntitiesApi* | [**delete_entity_workspace_settings**](docs/EntitiesApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace +*EntitiesApi* | [**delete_entity_workspace_themes**](docs/EntitiesApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme *EntitiesApi* | [**delete_entity_workspaces**](docs/EntitiesApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity *EntitiesApi* | [**get_all_automations_workspace_automations**](docs/EntitiesApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces *EntitiesApi* | [**get_all_entities**](docs/EntitiesApi.md#get_all_entities) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities (Removed) @@ -966,6 +1004,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_facts**](docs/EntitiesApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts *EntitiesApi* | [**get_all_entities_filter_contexts**](docs/EntitiesApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context *EntitiesApi* | [**get_all_entities_filter_views**](docs/EntitiesApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views +*EntitiesApi* | [**get_all_entities_fiscal_calendars**](docs/EntitiesApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars *EntitiesApi* | [**get_all_entities_identity_providers**](docs/EntitiesApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers *EntitiesApi* | [**get_all_entities_ip_allowlist_policies**](docs/EntitiesApi.md#get_all_entities_ip_allowlist_policies) | **GET** /api/v1/entities/ipAllowlistPolicies | Get all IpAllowlistPolicy entities *EntitiesApi* | [**get_all_entities_jwks**](docs/EntitiesApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks @@ -976,6 +1015,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_metrics**](docs/EntitiesApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics *EntitiesApi* | [**get_all_entities_notification_channel_identifiers**](docs/EntitiesApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | Get all Notification Channel Identifier entities *EntitiesApi* | [**get_all_entities_notification_channels**](docs/EntitiesApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities +*EntitiesApi* | [**get_all_entities_org_memory_items**](docs/EntitiesApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities *EntitiesApi* | [**get_all_entities_organization_settings**](docs/EntitiesApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization Setting entities *EntitiesApi* | [**get_all_entities_parameters**](docs/EntitiesApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters *EntitiesApi* | [**get_all_entities_themes**](docs/EntitiesApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities @@ -985,9 +1025,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_user_settings**](docs/EntitiesApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user *EntitiesApi* | [**get_all_entities_users**](docs/EntitiesApi.md#get_all_entities_users) | **GET** /api/v1/entities/users | Get User entities *EntitiesApi* | [**get_all_entities_visualization_objects**](docs/EntitiesApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects +*EntitiesApi* | [**get_all_entities_workspace_color_palettes**](docs/EntitiesApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes *EntitiesApi* | [**get_all_entities_workspace_data_filter_settings**](docs/EntitiesApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters *EntitiesApi* | [**get_all_entities_workspace_data_filters**](docs/EntitiesApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters +*EntitiesApi* | [**get_all_entities_workspace_export_templates**](docs/EntitiesApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates *EntitiesApi* | [**get_all_entities_workspace_settings**](docs/EntitiesApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces +*EntitiesApi* | [**get_all_entities_workspace_themes**](docs/EntitiesApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes *EntitiesApi* | [**get_all_entities_workspaces**](docs/EntitiesApi.md#get_all_entities_workspaces) | **GET** /api/v1/entities/workspaces | Get Workspace entities *EntitiesApi* | [**get_all_options**](docs/EntitiesApi.md#get_all_options) | **GET** /api/v1/options | Links for all configuration options *EntitiesApi* | [**get_data_source_drivers**](docs/EntitiesApi.md#get_data_source_drivers) | **GET** /api/v1/options/availableDrivers | Get all available data source drivers @@ -1015,6 +1058,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_facts**](docs/EntitiesApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact *EntitiesApi* | [**get_entity_filter_contexts**](docs/EntitiesApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context *EntitiesApi* | [**get_entity_filter_views**](docs/EntitiesApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +*EntitiesApi* | [**get_entity_fiscal_calendars**](docs/EntitiesApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar *EntitiesApi* | [**get_entity_identity_providers**](docs/EntitiesApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider *EntitiesApi* | [**get_entity_ip_allowlist_policies**](docs/EntitiesApi.md#get_entity_ip_allowlist_policies) | **GET** /api/v1/entities/ipAllowlistPolicies/{id} | Get IpAllowlistPolicy entity *EntitiesApi* | [**get_entity_jwks**](docs/EntitiesApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk @@ -1025,6 +1069,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_metrics**](docs/EntitiesApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric *EntitiesApi* | [**get_entity_notification_channel_identifiers**](docs/EntitiesApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | Get Notification Channel Identifier entity *EntitiesApi* | [**get_entity_notification_channels**](docs/EntitiesApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity +*EntitiesApi* | [**get_entity_org_memory_items**](docs/EntitiesApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity *EntitiesApi* | [**get_entity_organization_settings**](docs/EntitiesApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization Setting entity *EntitiesApi* | [**get_entity_organizations**](docs/EntitiesApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations *EntitiesApi* | [**get_entity_parameters**](docs/EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter @@ -1035,9 +1080,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_user_settings**](docs/EntitiesApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user *EntitiesApi* | [**get_entity_users**](docs/EntitiesApi.md#get_entity_users) | **GET** /api/v1/entities/users/{id} | Get User entity *EntitiesApi* | [**get_entity_visualization_objects**](docs/EntitiesApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object +*EntitiesApi* | [**get_entity_workspace_color_palettes**](docs/EntitiesApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette *EntitiesApi* | [**get_entity_workspace_data_filter_settings**](docs/EntitiesApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter *EntitiesApi* | [**get_entity_workspace_data_filters**](docs/EntitiesApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter +*EntitiesApi* | [**get_entity_workspace_export_templates**](docs/EntitiesApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template *EntitiesApi* | [**get_entity_workspace_settings**](docs/EntitiesApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace +*EntitiesApi* | [**get_entity_workspace_themes**](docs/EntitiesApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme *EntitiesApi* | [**get_entity_workspaces**](docs/EntitiesApi.md#get_entity_workspaces) | **GET** /api/v1/entities/workspaces/{id} | Get Workspace entity *EntitiesApi* | [**get_organization**](docs/EntitiesApi.md#get_organization) | **GET** /api/v1/entities/organization | Get current organization info *EntitiesApi* | [**patch_entity**](docs/EntitiesApi.md#patch_entity) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity (Removed) @@ -1067,6 +1115,7 @@ Class | Method | HTTP request | Description *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 *EntitiesApi* | [**patch_entity_notification_channels**](docs/EntitiesApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity +*EntitiesApi* | [**patch_entity_org_memory_items**](docs/EntitiesApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity *EntitiesApi* | [**patch_entity_organization_settings**](docs/EntitiesApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization Setting entity *EntitiesApi* | [**patch_entity_organizations**](docs/EntitiesApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization *EntitiesApi* | [**patch_entity_parameters**](docs/EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter @@ -1075,9 +1124,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_user_groups**](docs/EntitiesApi.md#patch_entity_user_groups) | **PATCH** /api/v1/entities/userGroups/{id} | Patch UserGroup entity *EntitiesApi* | [**patch_entity_users**](docs/EntitiesApi.md#patch_entity_users) | **PATCH** /api/v1/entities/users/{id} | Patch User entity *EntitiesApi* | [**patch_entity_visualization_objects**](docs/EntitiesApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object +*EntitiesApi* | [**patch_entity_workspace_color_palettes**](docs/EntitiesApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette *EntitiesApi* | [**patch_entity_workspace_data_filter_settings**](docs/EntitiesApi.md#patch_entity_workspace_data_filter_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Patch a Settings for Workspace Data Filter *EntitiesApi* | [**patch_entity_workspace_data_filters**](docs/EntitiesApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter +*EntitiesApi* | [**patch_entity_workspace_export_templates**](docs/EntitiesApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template *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) @@ -1127,6 +1179,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_memory_items**](docs/EntitiesApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item *EntitiesApi* | [**update_entity_metrics**](docs/EntitiesApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric *EntitiesApi* | [**update_entity_notification_channels**](docs/EntitiesApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity +*EntitiesApi* | [**update_entity_org_memory_items**](docs/EntitiesApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity *EntitiesApi* | [**update_entity_organization_settings**](docs/EntitiesApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization Setting entity *EntitiesApi* | [**update_entity_organizations**](docs/EntitiesApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization *EntitiesApi* | [**update_entity_parameters**](docs/EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter @@ -1136,9 +1189,12 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_user_settings**](docs/EntitiesApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user *EntitiesApi* | [**update_entity_users**](docs/EntitiesApi.md#update_entity_users) | **PUT** /api/v1/entities/users/{id} | Put User entity *EntitiesApi* | [**update_entity_visualization_objects**](docs/EntitiesApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object +*EntitiesApi* | [**update_entity_workspace_color_palettes**](docs/EntitiesApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette *EntitiesApi* | [**update_entity_workspace_data_filter_settings**](docs/EntitiesApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter *EntitiesApi* | [**update_entity_workspace_data_filters**](docs/EntitiesApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter +*EntitiesApi* | [**update_entity_workspace_export_templates**](docs/EntitiesApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template *EntitiesApi* | [**update_entity_workspace_settings**](docs/EntitiesApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace +*EntitiesApi* | [**update_entity_workspace_themes**](docs/EntitiesApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme *EntitiesApi* | [**update_entity_workspaces**](docs/EntitiesApi.md#update_entity_workspaces) | **PUT** /api/v1/entities/workspaces/{id} | Put Workspace entity *EntitlementEntityControllerApi* | [**get_all_entities_entitlements**](docs/EntitlementEntityControllerApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements *EntitlementEntityControllerApi* | [**get_entity_entitlements**](docs/EntitlementEntityControllerApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement entity @@ -1173,6 +1229,8 @@ Class | Method | HTTP request | Description *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* | [**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 *IdentityProviderControllerApi* | [**create_entity_identity_providers**](docs/IdentityProviderControllerApi.md#create_entity_identity_providers) | **POST** /api/v1/entities/identityProviders | Post Identity Providers *IdentityProviderControllerApi* | [**delete_entity_identity_providers**](docs/IdentityProviderControllerApi.md#delete_entity_identity_providers) | **DELETE** /api/v1/entities/identityProviders/{id} | Delete Identity Provider *IdentityProviderControllerApi* | [**get_all_entities_identity_providers**](docs/IdentityProviderControllerApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers @@ -1278,6 +1336,12 @@ Class | Method | HTTP request | Description *NotificationChannelControllerApi* | [**update_entity_notification_channels**](docs/NotificationChannelControllerApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity *NotificationChannelIdentifierControllerApi* | [**get_all_entities_notification_channel_identifiers**](docs/NotificationChannelIdentifierControllerApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | Get all Notification Channel Identifier entities *NotificationChannelIdentifierControllerApi* | [**get_entity_notification_channel_identifiers**](docs/NotificationChannelIdentifierControllerApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | Get Notification Channel Identifier entity +*OrgMemoryItemControllerApi* | [**create_entity_org_memory_items**](docs/OrgMemoryItemControllerApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities +*OrgMemoryItemControllerApi* | [**delete_entity_org_memory_items**](docs/OrgMemoryItemControllerApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity +*OrgMemoryItemControllerApi* | [**get_all_entities_org_memory_items**](docs/OrgMemoryItemControllerApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities +*OrgMemoryItemControllerApi* | [**get_entity_org_memory_items**](docs/OrgMemoryItemControllerApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity +*OrgMemoryItemControllerApi* | [**patch_entity_org_memory_items**](docs/OrgMemoryItemControllerApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity +*OrgMemoryItemControllerApi* | [**update_entity_org_memory_items**](docs/OrgMemoryItemControllerApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity *OrganizationEntityControllerApi* | [**get_entity_organizations**](docs/OrganizationEntityControllerApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations *OrganizationEntityControllerApi* | [**patch_entity_organizations**](docs/OrganizationEntityControllerApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization *OrganizationEntityControllerApi* | [**update_entity_organizations**](docs/OrganizationEntityControllerApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization @@ -1333,6 +1397,12 @@ Class | Method | HTTP request | Description *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* | [**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 +*WorkspaceColorPaletteControllerApi* | [**get_all_entities_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes +*WorkspaceColorPaletteControllerApi* | [**get_entity_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette +*WorkspaceColorPaletteControllerApi* | [**patch_entity_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette +*WorkspaceColorPaletteControllerApi* | [**update_entity_workspace_color_palettes**](docs/WorkspaceColorPaletteControllerApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette *WorkspaceControllerApi* | [**create_entity_workspaces**](docs/WorkspaceControllerApi.md#create_entity_workspaces) | **POST** /api/v1/entities/workspaces | Post Workspace entities *WorkspaceControllerApi* | [**delete_entity_workspaces**](docs/WorkspaceControllerApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity *WorkspaceControllerApi* | [**get_all_entities_workspaces**](docs/WorkspaceControllerApi.md#get_all_entities_workspaces) | **GET** /api/v1/entities/workspaces | Get Workspace entities @@ -1353,6 +1423,12 @@ Class | Method | HTTP request | Description *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* | [**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 +*WorkspaceExportTemplateControllerApi* | [**get_all_entities_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates +*WorkspaceExportTemplateControllerApi* | [**get_entity_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template +*WorkspaceExportTemplateControllerApi* | [**patch_entity_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template +*WorkspaceExportTemplateControllerApi* | [**update_entity_workspace_export_templates**](docs/WorkspaceExportTemplateControllerApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template *WorkspaceSettingControllerApi* | [**create_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces *WorkspaceSettingControllerApi* | [**delete_entity_workspace_settings**](docs/WorkspaceSettingControllerApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace *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 @@ -1360,14 +1436,21 @@ Class | Method | HTTP request | Description *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* | [**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 +*WorkspaceThemeControllerApi* | [**get_all_entities_workspace_themes**](docs/WorkspaceThemeControllerApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes +*WorkspaceThemeControllerApi* | [**get_entity_workspace_themes**](docs/WorkspaceThemeControllerApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme +*WorkspaceThemeControllerApi* | [**patch_entity_workspace_themes**](docs/WorkspaceThemeControllerApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme +*WorkspaceThemeControllerApi* | [**update_entity_workspace_themes**](docs/WorkspaceThemeControllerApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme ## Documentation For Models - [AFM](docs/AFM.md) - - [AFMFiltersInner](docs/AFMFiltersInner.md) - [AbsoluteDateFilter](docs/AbsoluteDateFilter.md) - [AbsoluteDateFilterAbsoluteDateFilter](docs/AbsoluteDateFilterAbsoluteDateFilter.md) + - [AbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilter.md) + - [AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) - [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md) - [ActiveObjectIdentification](docs/ActiveObjectIdentification.md) - [AdHocAutomation](docs/AdHocAutomation.md) @@ -1448,7 +1531,6 @@ Class | Method | HTTP request | Description - [AttributePositiveFilterAllOf](docs/AttributePositiveFilterAllOf.md) - [AttributeResultHeader](docs/AttributeResultHeader.md) - [AutomationAlert](docs/AutomationAlert.md) - - [AutomationAlertCondition](docs/AutomationAlertCondition.md) - [AutomationDashboardTabularExport](docs/AutomationDashboardTabularExport.md) - [AutomationExternalRecipient](docs/AutomationExternalRecipient.md) - [AutomationImageExport](docs/AutomationImageExport.md) @@ -1471,9 +1553,14 @@ Class | Method | HTTP request | Description - [BedrockProviderAuth](docs/BedrockProviderAuth.md) - [BoundedFilter](docs/BoundedFilter.md) - [CacheRemovalInterval](docs/CacheRemovalInterval.md) + - [CacheRetention](docs/CacheRetention.md) + - [CacheRetentionSchedule](docs/CacheRetentionSchedule.md) - [CacheUsageData](docs/CacheUsageData.md) + - [CalendarDefinition](docs/CalendarDefinition.md) + - [CalendarGranularity](docs/CalendarGranularity.md) + - [CalendarTableReference](docs/CalendarTableReference.md) + - [CertificationInfo](docs/CertificationInfo.md) - [ChangeAnalysisParams](docs/ChangeAnalysisParams.md) - - [ChangeAnalysisParamsFiltersInner](docs/ChangeAnalysisParamsFiltersInner.md) - [ChangeAnalysisRequest](docs/ChangeAnalysisRequest.md) - [ChangeAnalysisResponse](docs/ChangeAnalysisResponse.md) - [ChangeAnalysisResult](docs/ChangeAnalysisResult.md) @@ -1511,6 +1598,9 @@ Class | Method | HTTP request | Description - [ConvertGeoFileResponse](docs/ConvertGeoFileResponse.md) - [CoverSlideTemplate](docs/CoverSlideTemplate.md) - [CreatePipeTableRequest](docs/CreatePipeTableRequest.md) + - [CreatePipeTableRequestDistributionConfig](docs/CreatePipeTableRequestDistributionConfig.md) + - [CreatePipeTableRequestKeyConfig](docs/CreatePipeTableRequestKeyConfig.md) + - [CreatePipeTableRequestPartitionConfig](docs/CreatePipeTableRequestPartitionConfig.md) - [CreatedVisualization](docs/CreatedVisualization.md) - [CreatedVisualizationFiltersInner](docs/CreatedVisualizationFiltersInner.md) - [CreatedVisualizations](docs/CreatedVisualizations.md) @@ -1519,6 +1609,8 @@ Class | Method | HTTP request | Description - [CsvManifestBody](docs/CsvManifestBody.md) - [CsvParseOptions](docs/CsvParseOptions.md) - [CsvReadOptions](docs/CsvReadOptions.md) + - [CustomCalendarDefinition](docs/CustomCalendarDefinition.md) + - [CustomCalendarDefinitionAllOf](docs/CustomCalendarDefinitionAllOf.md) - [CustomLabel](docs/CustomLabel.md) - [CustomMetric](docs/CustomMetric.md) - [CustomOverride](docs/CustomOverride.md) @@ -1541,7 +1633,6 @@ Class | Method | HTTP request | Description - [DashboardMatchAttributeFilterMatchAttributeFilter](docs/DashboardMatchAttributeFilterMatchAttributeFilter.md) - [DashboardMeasureValueFilter](docs/DashboardMeasureValueFilter.md) - [DashboardMeasureValueFilterDashboardMeasureValueFilter](docs/DashboardMeasureValueFilterDashboardMeasureValueFilter.md) - - [DashboardParameterValue](docs/DashboardParameterValue.md) - [DashboardPermissions](docs/DashboardPermissions.md) - [DashboardPermissionsAssignment](docs/DashboardPermissionsAssignment.md) - [DashboardSlidesTemplate](docs/DashboardSlidesTemplate.md) @@ -1584,6 +1675,7 @@ Class | Method | HTTP request | Description - [DeclarativeAttribute](docs/DeclarativeAttribute.md) - [DeclarativeAttributeHierarchy](docs/DeclarativeAttributeHierarchy.md) - [DeclarativeAutomation](docs/DeclarativeAutomation.md) + - [DeclarativeCalendar](docs/DeclarativeCalendar.md) - [DeclarativeColorPalette](docs/DeclarativeColorPalette.md) - [DeclarativeColumn](docs/DeclarativeColumn.md) - [DeclarativeCspDirective](docs/DeclarativeCspDirective.md) @@ -1601,7 +1693,6 @@ Class | Method | HTTP request | Description - [DeclarativeDateDataset](docs/DeclarativeDateDataset.md) - [DeclarativeExportDefinition](docs/DeclarativeExportDefinition.md) - [DeclarativeExportDefinitionIdentifier](docs/DeclarativeExportDefinitionIdentifier.md) - - [DeclarativeExportDefinitionRequestPayload](docs/DeclarativeExportDefinitionRequestPayload.md) - [DeclarativeExportTemplate](docs/DeclarativeExportTemplate.md) - [DeclarativeExportTemplates](docs/DeclarativeExportTemplates.md) - [DeclarativeFact](docs/DeclarativeFact.md) @@ -1619,14 +1710,12 @@ Class | Method | HTTP request | Description - [DeclarativeMetric](docs/DeclarativeMetric.md) - [DeclarativeModel](docs/DeclarativeModel.md) - [DeclarativeNotificationChannel](docs/DeclarativeNotificationChannel.md) - - [DeclarativeNotificationChannelDestination](docs/DeclarativeNotificationChannelDestination.md) - [DeclarativeNotificationChannelIdentifier](docs/DeclarativeNotificationChannelIdentifier.md) - [DeclarativeNotificationChannels](docs/DeclarativeNotificationChannels.md) - [DeclarativeOrganization](docs/DeclarativeOrganization.md) - [DeclarativeOrganizationInfo](docs/DeclarativeOrganizationInfo.md) - [DeclarativeOrganizationPermission](docs/DeclarativeOrganizationPermission.md) - [DeclarativeParameter](docs/DeclarativeParameter.md) - - [DeclarativeParameterContent](docs/DeclarativeParameterContent.md) - [DeclarativeReference](docs/DeclarativeReference.md) - [DeclarativeReferenceSource](docs/DeclarativeReferenceSource.md) - [DeclarativeRsaSpecification](docs/DeclarativeRsaSpecification.md) @@ -1651,14 +1740,17 @@ Class | Method | HTTP request | Description - [DeclarativeUsersUserGroups](docs/DeclarativeUsersUserGroups.md) - [DeclarativeVisualizationObject](docs/DeclarativeVisualizationObject.md) - [DeclarativeWorkspace](docs/DeclarativeWorkspace.md) + - [DeclarativeWorkspaceColorPalette](docs/DeclarativeWorkspaceColorPalette.md) - [DeclarativeWorkspaceDataFilter](docs/DeclarativeWorkspaceDataFilter.md) - [DeclarativeWorkspaceDataFilterColumn](docs/DeclarativeWorkspaceDataFilterColumn.md) - [DeclarativeWorkspaceDataFilterReferences](docs/DeclarativeWorkspaceDataFilterReferences.md) - [DeclarativeWorkspaceDataFilterSetting](docs/DeclarativeWorkspaceDataFilterSetting.md) - [DeclarativeWorkspaceDataFilters](docs/DeclarativeWorkspaceDataFilters.md) + - [DeclarativeWorkspaceExportTemplate](docs/DeclarativeWorkspaceExportTemplate.md) - [DeclarativeWorkspaceHierarchyPermission](docs/DeclarativeWorkspaceHierarchyPermission.md) - [DeclarativeWorkspaceModel](docs/DeclarativeWorkspaceModel.md) - [DeclarativeWorkspacePermissions](docs/DeclarativeWorkspacePermissions.md) + - [DeclarativeWorkspaceTheme](docs/DeclarativeWorkspaceTheme.md) - [DeclarativeWorkspaces](docs/DeclarativeWorkspaces.md) - [DefaultSmtp](docs/DefaultSmtp.md) - [DefaultSmtpAllOf](docs/DefaultSmtpAllOf.md) @@ -1711,6 +1803,8 @@ Class | Method | HTTP request | Description - [FilterBy](docs/FilterBy.md) - [FilterDefinition](docs/FilterDefinition.md) - [FilterDefinitionForSimpleMeasure](docs/FilterDefinitionForSimpleMeasure.md) + - [FiscalYearCalendarDefinition](docs/FiscalYearCalendarDefinition.md) + - [FiscalYearCalendarDefinitionAllOf](docs/FiscalYearCalendarDefinitionAllOf.md) - [ForecastConfig](docs/ForecastConfig.md) - [ForecastRequest](docs/ForecastRequest.md) - [ForecastResult](docs/ForecastResult.md) @@ -1719,6 +1813,8 @@ Class | Method | HTTP request | Description - [FrequencyBucket](docs/FrequencyBucket.md) - [FrequencyProperties](docs/FrequencyProperties.md) - [GdStorageFile](docs/GdStorageFile.md) + - [GenAiRankingFilter](docs/GenAiRankingFilter.md) + - [GenAiRankingFilterAllOf](docs/GenAiRankingFilterAllOf.md) - [GenerateDescriptionRequest](docs/GenerateDescriptionRequest.md) - [GenerateDescriptionResponse](docs/GenerateDescriptionResponse.md) - [GenerateLdmRequest](docs/GenerateLdmRequest.md) @@ -1755,6 +1851,7 @@ Class | Method | HTTP request | Description - [ImportGeoCollectionResponse](docs/ImportGeoCollectionResponse.md) - [InPlatform](docs/InPlatform.md) - [InPlatformAllOf](docs/InPlatformAllOf.md) + - [IndefiniteCacheRetention](docs/IndefiniteCacheRetention.md) - [InlineFilterDefinition](docs/InlineFilterDefinition.md) - [InlineFilterDefinitionInline](docs/InlineFilterDefinitionInline.md) - [InlineMeasureDefinition](docs/InlineMeasureDefinition.md) @@ -1976,6 +2073,7 @@ Class | Method | HTTP request | Description - [JsonApiDataSourceIdentifierOutWithLinks](docs/JsonApiDataSourceIdentifierOutWithLinks.md) - [JsonApiDataSourceIn](docs/JsonApiDataSourceIn.md) - [JsonApiDataSourceInAttributes](docs/JsonApiDataSourceInAttributes.md) + - [JsonApiDataSourceInAttributesCacheRetention](docs/JsonApiDataSourceInAttributesCacheRetention.md) - [JsonApiDataSourceInAttributesParametersInner](docs/JsonApiDataSourceInAttributesParametersInner.md) - [JsonApiDataSourceInDocument](docs/JsonApiDataSourceInDocument.md) - [JsonApiDataSourceOut](docs/JsonApiDataSourceOut.md) @@ -2086,6 +2184,13 @@ Class | Method | HTTP request | Description - [JsonApiFilterViewPatch](docs/JsonApiFilterViewPatch.md) - [JsonApiFilterViewPatchAttributes](docs/JsonApiFilterViewPatchAttributes.md) - [JsonApiFilterViewPatchDocument](docs/JsonApiFilterViewPatchDocument.md) + - [JsonApiFiscalCalendarOut](docs/JsonApiFiscalCalendarOut.md) + - [JsonApiFiscalCalendarOutAttributes](docs/JsonApiFiscalCalendarOutAttributes.md) + - [JsonApiFiscalCalendarOutAttributesDefinition](docs/JsonApiFiscalCalendarOutAttributesDefinition.md) + - [JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner](docs/JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md) + - [JsonApiFiscalCalendarOutDocument](docs/JsonApiFiscalCalendarOutDocument.md) + - [JsonApiFiscalCalendarOutList](docs/JsonApiFiscalCalendarOutList.md) + - [JsonApiFiscalCalendarOutWithLinks](docs/JsonApiFiscalCalendarOutWithLinks.md) - [JsonApiIdentityProviderIn](docs/JsonApiIdentityProviderIn.md) - [JsonApiIdentityProviderInAttributes](docs/JsonApiIdentityProviderInAttributes.md) - [JsonApiIdentityProviderInDocument](docs/JsonApiIdentityProviderInDocument.md) @@ -2223,6 +2328,17 @@ Class | Method | HTTP request | Description - [JsonApiNotificationChannelPostOptionalId](docs/JsonApiNotificationChannelPostOptionalId.md) - [JsonApiNotificationChannelPostOptionalIdDocument](docs/JsonApiNotificationChannelPostOptionalIdDocument.md) - [JsonApiNotificationChannelToOneLinkage](docs/JsonApiNotificationChannelToOneLinkage.md) + - [JsonApiOrgMemoryItemIn](docs/JsonApiOrgMemoryItemIn.md) + - [JsonApiOrgMemoryItemInAttributes](docs/JsonApiOrgMemoryItemInAttributes.md) + - [JsonApiOrgMemoryItemInDocument](docs/JsonApiOrgMemoryItemInDocument.md) + - [JsonApiOrgMemoryItemOut](docs/JsonApiOrgMemoryItemOut.md) + - [JsonApiOrgMemoryItemOutAttributes](docs/JsonApiOrgMemoryItemOutAttributes.md) + - [JsonApiOrgMemoryItemOutDocument](docs/JsonApiOrgMemoryItemOutDocument.md) + - [JsonApiOrgMemoryItemOutList](docs/JsonApiOrgMemoryItemOutList.md) + - [JsonApiOrgMemoryItemOutWithLinks](docs/JsonApiOrgMemoryItemOutWithLinks.md) + - [JsonApiOrgMemoryItemPatch](docs/JsonApiOrgMemoryItemPatch.md) + - [JsonApiOrgMemoryItemPatchAttributes](docs/JsonApiOrgMemoryItemPatchAttributes.md) + - [JsonApiOrgMemoryItemPatchDocument](docs/JsonApiOrgMemoryItemPatchDocument.md) - [JsonApiOrganizationIn](docs/JsonApiOrganizationIn.md) - [JsonApiOrganizationInAttributes](docs/JsonApiOrganizationInAttributes.md) - [JsonApiOrganizationInDocument](docs/JsonApiOrganizationInDocument.md) @@ -2348,6 +2464,14 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceAutomationOutRelationships](docs/JsonApiWorkspaceAutomationOutRelationships.md) - [JsonApiWorkspaceAutomationOutRelationshipsWorkspace](docs/JsonApiWorkspaceAutomationOutRelationshipsWorkspace.md) - [JsonApiWorkspaceAutomationOutWithLinks](docs/JsonApiWorkspaceAutomationOutWithLinks.md) + - [JsonApiWorkspaceColorPaletteIn](docs/JsonApiWorkspaceColorPaletteIn.md) + - [JsonApiWorkspaceColorPaletteInDocument](docs/JsonApiWorkspaceColorPaletteInDocument.md) + - [JsonApiWorkspaceColorPaletteOut](docs/JsonApiWorkspaceColorPaletteOut.md) + - [JsonApiWorkspaceColorPaletteOutDocument](docs/JsonApiWorkspaceColorPaletteOutDocument.md) + - [JsonApiWorkspaceColorPaletteOutList](docs/JsonApiWorkspaceColorPaletteOutList.md) + - [JsonApiWorkspaceColorPaletteOutWithLinks](docs/JsonApiWorkspaceColorPaletteOutWithLinks.md) + - [JsonApiWorkspaceColorPalettePatch](docs/JsonApiWorkspaceColorPalettePatch.md) + - [JsonApiWorkspaceColorPalettePatchDocument](docs/JsonApiWorkspaceColorPalettePatchDocument.md) - [JsonApiWorkspaceDataFilterIn](docs/JsonApiWorkspaceDataFilterIn.md) - [JsonApiWorkspaceDataFilterInAttributes](docs/JsonApiWorkspaceDataFilterInAttributes.md) - [JsonApiWorkspaceDataFilterInDocument](docs/JsonApiWorkspaceDataFilterInDocument.md) @@ -2375,6 +2499,20 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceDataFilterSettingToManyLinkage](docs/JsonApiWorkspaceDataFilterSettingToManyLinkage.md) - [JsonApiWorkspaceDataFilterToManyLinkage](docs/JsonApiWorkspaceDataFilterToManyLinkage.md) - [JsonApiWorkspaceDataFilterToOneLinkage](docs/JsonApiWorkspaceDataFilterToOneLinkage.md) + - [JsonApiWorkspaceExportTemplateIn](docs/JsonApiWorkspaceExportTemplateIn.md) + - [JsonApiWorkspaceExportTemplateInAttributes](docs/JsonApiWorkspaceExportTemplateInAttributes.md) + - [JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate](docs/JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md) + - [JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate](docs/JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.md) + - [JsonApiWorkspaceExportTemplateInDocument](docs/JsonApiWorkspaceExportTemplateInDocument.md) + - [JsonApiWorkspaceExportTemplateOut](docs/JsonApiWorkspaceExportTemplateOut.md) + - [JsonApiWorkspaceExportTemplateOutDocument](docs/JsonApiWorkspaceExportTemplateOutDocument.md) + - [JsonApiWorkspaceExportTemplateOutList](docs/JsonApiWorkspaceExportTemplateOutList.md) + - [JsonApiWorkspaceExportTemplateOutWithLinks](docs/JsonApiWorkspaceExportTemplateOutWithLinks.md) + - [JsonApiWorkspaceExportTemplatePatch](docs/JsonApiWorkspaceExportTemplatePatch.md) + - [JsonApiWorkspaceExportTemplatePatchAttributes](docs/JsonApiWorkspaceExportTemplatePatchAttributes.md) + - [JsonApiWorkspaceExportTemplatePatchDocument](docs/JsonApiWorkspaceExportTemplatePatchDocument.md) + - [JsonApiWorkspaceExportTemplatePostOptionalId](docs/JsonApiWorkspaceExportTemplatePostOptionalId.md) + - [JsonApiWorkspaceExportTemplatePostOptionalIdDocument](docs/JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md) - [JsonApiWorkspaceIn](docs/JsonApiWorkspaceIn.md) - [JsonApiWorkspaceInAttributes](docs/JsonApiWorkspaceInAttributes.md) - [JsonApiWorkspaceInAttributesDataSource](docs/JsonApiWorkspaceInAttributesDataSource.md) @@ -2382,6 +2520,7 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceInRelationships](docs/JsonApiWorkspaceInRelationships.md) - [JsonApiWorkspaceLinkage](docs/JsonApiWorkspaceLinkage.md) - [JsonApiWorkspaceOut](docs/JsonApiWorkspaceOut.md) + - [JsonApiWorkspaceOutAttributes](docs/JsonApiWorkspaceOutAttributes.md) - [JsonApiWorkspaceOutDocument](docs/JsonApiWorkspaceOutDocument.md) - [JsonApiWorkspaceOutList](docs/JsonApiWorkspaceOutList.md) - [JsonApiWorkspaceOutMeta](docs/JsonApiWorkspaceOutMeta.md) @@ -2401,6 +2540,14 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceSettingPatchDocument](docs/JsonApiWorkspaceSettingPatchDocument.md) - [JsonApiWorkspaceSettingPostOptionalId](docs/JsonApiWorkspaceSettingPostOptionalId.md) - [JsonApiWorkspaceSettingPostOptionalIdDocument](docs/JsonApiWorkspaceSettingPostOptionalIdDocument.md) + - [JsonApiWorkspaceThemeIn](docs/JsonApiWorkspaceThemeIn.md) + - [JsonApiWorkspaceThemeInDocument](docs/JsonApiWorkspaceThemeInDocument.md) + - [JsonApiWorkspaceThemeOut](docs/JsonApiWorkspaceThemeOut.md) + - [JsonApiWorkspaceThemeOutDocument](docs/JsonApiWorkspaceThemeOutDocument.md) + - [JsonApiWorkspaceThemeOutList](docs/JsonApiWorkspaceThemeOutList.md) + - [JsonApiWorkspaceThemeOutWithLinks](docs/JsonApiWorkspaceThemeOutWithLinks.md) + - [JsonApiWorkspaceThemePatch](docs/JsonApiWorkspaceThemePatch.md) + - [JsonApiWorkspaceThemePatchDocument](docs/JsonApiWorkspaceThemePatchDocument.md) - [JsonApiWorkspaceToOneLinkage](docs/JsonApiWorkspaceToOneLinkage.md) - [JsonNode](docs/JsonNode.md) - [KeyConfig](docs/KeyConfig.md) @@ -2417,18 +2564,17 @@ Class | Method | HTTP request | Description - [ListLinks](docs/ListLinks.md) - [ListLinksAllOf](docs/ListLinksAllOf.md) - [ListLlmProviderModelsRequest](docs/ListLlmProviderModelsRequest.md) - - [ListLlmProviderModelsRequestProviderConfig](docs/ListLlmProviderModelsRequestProviderConfig.md) - [ListLlmProviderModelsResponse](docs/ListLlmProviderModelsResponse.md) - [LiveFeatureFlagConfiguration](docs/LiveFeatureFlagConfiguration.md) - [LiveFeatures](docs/LiveFeatures.md) - [LiveFeaturesAllOf](docs/LiveFeaturesAllOf.md) - [LlmModel](docs/LlmModel.md) - - [LlmProviderAuth](docs/LlmProviderAuth.md) - [LlmProviderConfig](docs/LlmProviderConfig.md) - [LocalIdentifier](docs/LocalIdentifier.md) - [LocaleRequest](docs/LocaleRequest.md) - [ManageAttributePermissionsRequestInner](docs/ManageAttributePermissionsRequestInner.md) - [ManageDashboardPermissionsRequestInner](docs/ManageDashboardPermissionsRequestInner.md) + - [ManageMetricPermissionsRequestInner](docs/ManageMetricPermissionsRequestInner.md) - [MatchAttributeFilter](docs/MatchAttributeFilter.md) - [MatchAttributeFilterMatchAttributeFilter](docs/MatchAttributeFilterMatchAttributeFilter.md) - [MatomoService](docs/MatomoService.md) @@ -2437,7 +2583,6 @@ Class | Method | HTTP request | Description - [MeasureGroupHeaders](docs/MeasureGroupHeaders.md) - [MeasureHeader](docs/MeasureHeader.md) - [MeasureItem](docs/MeasureItem.md) - - [MeasureItemDefinition](docs/MeasureItemDefinition.md) - [MeasureResultHeader](docs/MeasureResultHeader.md) - [MeasureValueCondition](docs/MeasureValueCondition.md) - [MeasureValueFilter](docs/MeasureValueFilter.md) @@ -2445,6 +2590,10 @@ Class | Method | HTTP request | Description - [MemoryItemUser](docs/MemoryItemUser.md) - [Metric](docs/Metric.md) - [MetricDefinitionOverride](docs/MetricDefinitionOverride.md) + - [MetricPermissions](docs/MetricPermissions.md) + - [MetricPermissionsAssignment](docs/MetricPermissionsAssignment.md) + - [MetricPermissionsForAssignee](docs/MetricPermissionsForAssignee.md) + - [MetricPermissionsForAssigneeRule](docs/MetricPermissionsForAssigneeRule.md) - [MetricRecord](docs/MetricRecord.md) - [MetricValueChange](docs/MetricValueChange.md) - [ModelTestResult](docs/ModelTestResult.md) @@ -2457,6 +2606,7 @@ Class | Method | HTTP request | Description - [NotificationContent](docs/NotificationContent.md) - [NotificationData](docs/NotificationData.md) - [NotificationFilter](docs/NotificationFilter.md) + - [NotificationParameter](docs/NotificationParameter.md) - [Notifications](docs/Notifications.md) - [NotificationsMeta](docs/NotificationsMeta.md) - [NotificationsMetaTotal](docs/NotificationsMetaTotal.md) @@ -2489,6 +2639,7 @@ Class | Method | HTTP request | Description - [Parameter](docs/Parameter.md) - [ParameterDefinition](docs/ParameterDefinition.md) - [ParameterItem](docs/ParameterItem.md) + - [ParameterValue](docs/ParameterValue.md) - [PartitionConfig](docs/PartitionConfig.md) - [PdfTableStyle](docs/PdfTableStyle.md) - [PdfTableStyleProperty](docs/PdfTableStyleProperty.md) @@ -2499,9 +2650,6 @@ Class | Method | HTTP request | Description - [PermissionsForAssignee](docs/PermissionsForAssignee.md) - [PermissionsForAssigneeRule](docs/PermissionsForAssigneeRule.md) - [PipeTable](docs/PipeTable.md) - - [PipeTableDistributionConfig](docs/PipeTableDistributionConfig.md) - - [PipeTableKeyConfig](docs/PipeTableKeyConfig.md) - - [PipeTablePartitionConfig](docs/PipeTablePartitionConfig.md) - [PipeTableSummary](docs/PipeTableSummary.md) - [PlatformUsage](docs/PlatformUsage.md) - [PlatformUsageRequest](docs/PlatformUsageRequest.md) @@ -2573,6 +2721,7 @@ Class | Method | HTTP request | Description - [ScanResultPdm](docs/ScanResultPdm.md) - [ScanSqlRequest](docs/ScanSqlRequest.md) - [ScanSqlResponse](docs/ScanSqlResponse.md) + - [ScheduleCacheRetention](docs/ScheduleCacheRetention.md) - [SearchRelationshipObject](docs/SearchRelationshipObject.md) - [SearchRequest](docs/SearchRequest.md) - [SearchResult](docs/SearchResult.md) @@ -2602,6 +2751,7 @@ Class | Method | HTTP request | Description - [StaticFeatures](docs/StaticFeatures.md) - [StaticFeaturesAllOf](docs/StaticFeaturesAllOf.md) - [StringConstraints](docs/StringConstraints.md) + - [StringParameterAllowedValue](docs/StringParameterAllowedValue.md) - [StringParameterDefinition](docs/StringParameterDefinition.md) - [SucceededOperation](docs/SucceededOperation.md) - [SucceededOperationAllOf](docs/SucceededOperationAllOf.md) @@ -2615,6 +2765,7 @@ Class | Method | HTTP request | Description - [TableStatisticsResponse](docs/TableStatisticsResponse.md) - [TableStatisticsWarning](docs/TableStatisticsWarning.md) - [TableWarning](docs/TableWarning.md) + - [TabularExportExecution](docs/TabularExportExecution.md) - [TabularExportRequest](docs/TabularExportRequest.md) - [TelemetryConfig](docs/TelemetryConfig.md) - [TelemetryContext](docs/TelemetryContext.md) @@ -2661,6 +2812,7 @@ Class | Method | HTTP request | Description - [UserManagementWorkspacePermissionAssignment](docs/UserManagementWorkspacePermissionAssignment.md) - [UserPermission](docs/UserPermission.md) - [ValidateByItem](docs/ValidateByItem.md) + - [ValidityPeriodCacheRetention](docs/ValidityPeriodCacheRetention.md) - [Value](docs/Value.md) - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) @@ -2686,6 +2838,7 @@ Class | Method | HTTP request | Description - [WorkspaceCacheSettings](docs/WorkspaceCacheSettings.md) - [WorkspaceCacheUsage](docs/WorkspaceCacheUsage.md) - [WorkspaceCurrentCacheUsage](docs/WorkspaceCurrentCacheUsage.md) + - [WorkspaceDashboardSlidesTemplate](docs/WorkspaceDashboardSlidesTemplate.md) - [WorkspaceDataSource](docs/WorkspaceDataSource.md) - [WorkspaceIdentifier](docs/WorkspaceIdentifier.md) - [WorkspacePermissionAssignment](docs/WorkspacePermissionAssignment.md) @@ -2693,6 +2846,7 @@ Class | Method | HTTP request | Description - [WorkspaceUserGroup](docs/WorkspaceUserGroup.md) - [WorkspaceUserGroups](docs/WorkspaceUserGroups.md) - [WorkspaceUsers](docs/WorkspaceUsers.md) + - [WorkspaceWidgetSlidesTemplate](docs/WorkspaceWidgetSlidesTemplate.md) - [Xliff](docs/Xliff.md) diff --git a/gooddata-api-client/docs/AFM.md b/gooddata-api-client/docs/AFM.md index 2cd4a0bee..e15f4881c 100644 --- a/gooddata-api-client/docs/AFM.md +++ b/gooddata-api-client/docs/AFM.md @@ -6,7 +6,7 @@ Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | -**filters** | [**[AFMFiltersInner]**](AFMFiltersInner.md) | Various filter types to filter the execution result. | +**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Various filter types to filter the execution result. | **measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be computed. | **aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] **measure_definition_overrides** | [**[MetricDefinitionOverride]**](MetricDefinitionOverride.md) | (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition. | [optional] diff --git a/gooddata-api-client/docs/AFMFiltersInner.md b/gooddata-api-client/docs/AFMFiltersInner.md deleted file mode 100644 index c8ff00a9a..000000000 --- a/gooddata-api-client/docs/AFMFiltersInner.md +++ /dev/null @@ -1,21 +0,0 @@ -# AFMFiltersInner - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**compound_measure_value_filter** | [**CompoundMeasureValueFilterCompoundMeasureValueFilter**](CompoundMeasureValueFilterCompoundMeasureValueFilter.md) | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] -**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.md) | | [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/AIApi.md b/gooddata-api-client/docs/AIApi.md index dac699e1b..e3706dcb6 100644 --- a/gooddata-api-client/docs/AIApi.md +++ b/gooddata-api-client/docs/AIApi.md @@ -6,20 +6,24 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_entity_knowledge_recommendations**](AIApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations [**create_entity_memory_items**](AIApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items +[**create_entity_org_memory_items**](AIApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities [**delete_entity_knowledge_recommendations**](AIApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation [**delete_entity_memory_items**](AIApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item +[**delete_entity_org_memory_items**](AIApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity [**get_all_entities_knowledge_recommendations**](AIApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations [**get_all_entities_memory_items**](AIApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items +[**get_all_entities_org_memory_items**](AIApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities [**get_entity_knowledge_recommendations**](AIApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation [**get_entity_memory_items**](AIApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item -[**metadata_sync**](AIApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -[**metadata_sync_organization**](AIApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services +[**get_entity_org_memory_items**](AIApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity [**patch_entity_knowledge_recommendations**](AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation [**patch_entity_memory_items**](AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item +[**patch_entity_org_memory_items**](AIApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity [**search_entities_knowledge_recommendations**](AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) [**search_entities_memory_items**](AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) [**update_entity_knowledge_recommendations**](AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation [**update_entity_memory_items**](AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item +[**update_entity_org_memory_items**](AIApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity # **create_entity_knowledge_recommendations** @@ -237,6 +241,102 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument create_entity_org_memory_items(json_api_org_memory_item_in_document) + +Post organization Memory Item entities + +Organization-scoped AI memory item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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_api.AIApi(api_client) + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->create_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -367,6 +467,69 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_org_memory_items** +> delete_entity_org_memory_items(id) + +Delete an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_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_api.AIApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + + # example passing only required values which don't have defaults set + try: + # Delete an organization Memory Item entity + api_instance.delete_entity_org_memory_items(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->delete_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -567,10 +730,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) +# **get_all_entities_org_memory_items** +> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() -Get a Knowledge Recommendation +Get all organization Memory Item entities ### Example @@ -579,7 +742,7 @@ Get a Knowledge Recommendation import time import gooddata_api_client from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList 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. @@ -592,33 +755,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + 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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) meta_include = [ - "metaInclude=origin,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all organization Memory Item entities + api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling AIApi->get_all_entities_org_memory_items: %s\n" % e) ``` @@ -626,16 +783,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) ### Authorization @@ -655,10 +812,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_memory_items** -> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) +# **get_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) -Get a Memory Item +Get a Knowledge Recommendation ### Example @@ -667,7 +824,7 @@ Get a Memory Item import time import gooddata_api_client from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument 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. @@ -682,9 +839,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = ai_api.AIApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -693,20 +850,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id) + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) + print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) + print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) ``` @@ -723,7 +880,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -743,12 +900,10 @@ 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) -# **metadata_sync** -> metadata_sync(workspace_id) - -(BETA) Sync Metadata to other services +# **get_entity_memory_items** +> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) -(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. +Get a Memory Item ### Example @@ -757,6 +912,7 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import ai_api +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument 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. @@ -770,13 +926,32 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_api.AIApi(api_client) workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # (BETA) Sync Metadata to other services - api_instance.metadata_sync(workspace_id) + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->metadata_sync: %s\n" % e) + print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) ``` @@ -785,10 +960,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization @@ -797,23 +977,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**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) -# **metadata_sync_organization** -> metadata_sync_organization() +# **get_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) -(BETA) Sync organization scope Metadata to other services - -(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. +Get an organization Memory Item entity ### Example @@ -822,6 +1000,7 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import ai_api +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument 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. @@ -834,22 +1013,42 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_api.AIApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - # example, this endpoint has no required or optional parameters + # example passing only required values which don't have defaults set try: - # (BETA) Sync organization scope Metadata to other services - api_instance.metadata_sync_organization() + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->get_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->metadata_sync_organization: %s\n" % e) + print("Exception when calling AIApi->get_entity_org_memory_items: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -void (empty response body) +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) ### Authorization @@ -858,14 +1057,14 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**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) @@ -1084,6 +1283,104 @@ 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) + +# **patch_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + +Patch an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_api +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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_api.AIApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( + data=JsonApiOrgMemoryItemPatch( + attributes=JsonApiOrgMemoryItemPatchAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->patch_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -1513,3 +1810,101 @@ 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) +# **update_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + +Put an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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_api.AIApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AIApi->update_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + diff --git a/gooddata-api-client/docs/AILakeApi.md b/gooddata-api-client/docs/AILakeApi.md index 96c2aba13..a7e18cffa 100644 --- a/gooddata-api-client/docs/AILakeApi.md +++ b/gooddata-api-client/docs/AILakeApi.md @@ -99,7 +99,7 @@ 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) # **analyze_statistics** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} analyze_statistics(instance_id, analyze_statistics_request) +> analyze_statistics(instance_id, analyze_statistics_request) (BETA) Run ANALYZE TABLE for tables in a database instance @@ -136,8 +136,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Run ANALYZE TABLE for tables in a database instance - api_response = api_instance.analyze_statistics(instance_id, analyze_statistics_request) - pprint(api_response) + api_instance.analyze_statistics(instance_id, analyze_statistics_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->analyze_statistics: %s\n" % e) @@ -145,8 +144,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Run ANALYZE TABLE for tables in a database instance - api_response = api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) - pprint(api_response) + api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->analyze_statistics: %s\n" % e) ``` @@ -162,7 +160,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -171,7 +169,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -183,7 +181,7 @@ 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) # **create_ai_lake_pipe_table** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ai_lake_pipe_table(instance_id, create_pipe_table_request) +> create_ai_lake_pipe_table(instance_id, create_pipe_table_request) (BETA) Create a new AI Lake pipe table @@ -223,16 +221,10 @@ with gooddata_api_client.ApiClient() as api_client: column_overrides={ "key": "key_example", }, - distribution_config=DistributionConfig( - type="type_example", - ), - key_config=KeyConfig( - type="type_example", - ), + distribution_config=CreatePipeTableRequestDistributionConfig(None), + key_config=CreatePipeTableRequestKeyConfig(None), max_varchar_length=1, - partition_config=PartitionConfig( - type="type_example", - ), + partition_config=CreatePipeTableRequestPartitionConfig(None), path_prefix="path_prefix_example", polling_interval_seconds=1, source_storage_name="source_storage_name_example", @@ -246,8 +238,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Create a new AI Lake pipe table - api_response = api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - pprint(api_response) + api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->create_ai_lake_pipe_table: %s\n" % e) @@ -255,8 +246,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Create a new AI Lake pipe table - api_response = api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) - pprint(api_response) + api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->create_ai_lake_pipe_table: %s\n" % e) ``` @@ -272,7 +262,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -281,7 +271,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -293,7 +283,7 @@ 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) # **delete_ai_lake_pipe_table** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_ai_lake_pipe_table(instance_id, table_name) +> delete_ai_lake_pipe_table(instance_id, table_name) (BETA) Delete an AI Lake pipe table @@ -325,8 +315,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Delete an AI Lake pipe table - api_response = api_instance.delete_ai_lake_pipe_table(instance_id, table_name) - pprint(api_response) + api_instance.delete_ai_lake_pipe_table(instance_id, table_name) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->delete_ai_lake_pipe_table: %s\n" % e) @@ -334,8 +323,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an AI Lake pipe table - api_response = api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) - pprint(api_response) + api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->delete_ai_lake_pipe_table: %s\n" % e) ``` @@ -351,7 +339,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -360,7 +348,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -372,7 +360,7 @@ 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) # **deprovision_ai_lake_database_instance** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} deprovision_ai_lake_database_instance(instance_id) +> deprovision_ai_lake_database_instance(instance_id) (BETA) Delete an existing AILake Database instance @@ -403,8 +391,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Delete an existing AILake Database instance - api_response = api_instance.deprovision_ai_lake_database_instance(instance_id) - pprint(api_response) + api_instance.deprovision_ai_lake_database_instance(instance_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->deprovision_ai_lake_database_instance: %s\n" % e) @@ -412,8 +399,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an existing AILake Database instance - api_response = api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) - pprint(api_response) + api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->deprovision_ai_lake_database_instance: %s\n" % e) ``` @@ -428,7 +414,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -437,7 +423,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -746,8 +732,8 @@ 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. - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -776,8 +762,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -829,8 +815,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_api.AILakeApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -850,8 +836,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -903,8 +889,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_api.AILakeApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -924,8 +910,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -978,8 +964,8 @@ 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. - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -1008,8 +994,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -1061,8 +1047,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_api.AILakeApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -1082,8 +1068,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -1109,7 +1095,7 @@ 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) # **provision_ai_lake_database_instance** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request) +> provision_ai_lake_database_instance(provision_database_instance_request) (BETA) Create a new AILake Database instance @@ -1148,8 +1134,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Create a new AILake Database instance - api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request) - pprint(api_response) + api_instance.provision_ai_lake_database_instance(provision_database_instance_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->provision_ai_lake_database_instance: %s\n" % e) @@ -1157,8 +1142,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Create a new AILake Database instance - api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id) - pprint(api_response) + api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->provision_ai_lake_database_instance: %s\n" % e) ``` @@ -1173,7 +1157,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -1182,7 +1166,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -1194,7 +1178,7 @@ 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_pipe_table_partition** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) +> refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) (BETA) Refresh a pipe table partition @@ -1232,8 +1216,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Refresh a pipe table partition - api_response = api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - pprint(api_response) + api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) @@ -1241,8 +1224,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Refresh a pipe table partition - api_response = api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) - pprint(api_response) + api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) ``` @@ -1259,7 +1241,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -1268,7 +1250,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -1349,7 +1331,7 @@ 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) # **run_ai_lake_service_command** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} run_ai_lake_service_command(service_id, command_name, run_service_command_request) +> run_ai_lake_service_command(service_id, command_name, run_service_command_request) (BETA) Run an AI Lake services command @@ -1388,8 +1370,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Run an AI Lake services command - api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request) - pprint(api_response) + api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) @@ -1397,8 +1378,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Run an AI Lake services command - api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request, operation_id=operation_id) - pprint(api_response) + api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->run_ai_lake_service_command: %s\n" % e) ``` @@ -1415,7 +1395,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -1424,7 +1404,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details diff --git a/gooddata-api-client/docs/AILakeDatabasesApi.md b/gooddata-api-client/docs/AILakeDatabasesApi.md index 58cea9d5d..3a51b3d01 100644 --- a/gooddata-api-client/docs/AILakeDatabasesApi.md +++ b/gooddata-api-client/docs/AILakeDatabasesApi.md @@ -89,7 +89,7 @@ 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) # **deprovision_ai_lake_database_instance** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} deprovision_ai_lake_database_instance(instance_id) +> deprovision_ai_lake_database_instance(instance_id) (BETA) Delete an existing AILake Database instance @@ -120,8 +120,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Delete an existing AILake Database instance - api_response = api_instance.deprovision_ai_lake_database_instance(instance_id) - pprint(api_response) + api_instance.deprovision_ai_lake_database_instance(instance_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e) @@ -129,8 +128,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an existing AILake Database instance - api_response = api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) - pprint(api_response) + api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e) ``` @@ -145,7 +143,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -154,7 +152,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -260,8 +258,8 @@ 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. - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -290,8 +288,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -343,8 +341,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -364,8 +362,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -417,8 +415,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -438,8 +436,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -465,7 +463,7 @@ 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) # **provision_ai_lake_database_instance** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} provision_ai_lake_database_instance(provision_database_instance_request) +> provision_ai_lake_database_instance(provision_database_instance_request) (BETA) Create a new AILake Database instance @@ -504,8 +502,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Create a new AILake Database instance - api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request) - pprint(api_response) + api_instance.provision_ai_lake_database_instance(provision_database_instance_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e) @@ -513,8 +510,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Create a new AILake Database instance - api_response = api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id) - pprint(api_response) + api_instance.provision_ai_lake_database_instance(provision_database_instance_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeDatabasesApi->provision_ai_lake_database_instance: %s\n" % e) ``` @@ -529,7 +525,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -538,7 +534,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details diff --git a/gooddata-api-client/docs/AILakePipeTablesApi.md b/gooddata-api-client/docs/AILakePipeTablesApi.md index 3c0056f05..dc35587e0 100644 --- a/gooddata-api-client/docs/AILakePipeTablesApi.md +++ b/gooddata-api-client/docs/AILakePipeTablesApi.md @@ -13,7 +13,7 @@ Method | HTTP request | Description # **analyze_statistics** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} analyze_statistics(instance_id, analyze_statistics_request) +> analyze_statistics(instance_id, analyze_statistics_request) (BETA) Run ANALYZE TABLE for tables in a database instance @@ -50,8 +50,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Run ANALYZE TABLE for tables in a database instance - api_response = api_instance.analyze_statistics(instance_id, analyze_statistics_request) - pprint(api_response) + api_instance.analyze_statistics(instance_id, analyze_statistics_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->analyze_statistics: %s\n" % e) @@ -59,8 +58,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Run ANALYZE TABLE for tables in a database instance - api_response = api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) - pprint(api_response) + api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->analyze_statistics: %s\n" % e) ``` @@ -76,7 +74,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -85,7 +83,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -97,7 +95,7 @@ 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) # **create_ai_lake_pipe_table** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_ai_lake_pipe_table(instance_id, create_pipe_table_request) +> create_ai_lake_pipe_table(instance_id, create_pipe_table_request) (BETA) Create a new AI Lake pipe table @@ -137,16 +135,10 @@ with gooddata_api_client.ApiClient() as api_client: column_overrides={ "key": "key_example", }, - distribution_config=DistributionConfig( - type="type_example", - ), - key_config=KeyConfig( - type="type_example", - ), + distribution_config=CreatePipeTableRequestDistributionConfig(None), + key_config=CreatePipeTableRequestKeyConfig(None), max_varchar_length=1, - partition_config=PartitionConfig( - type="type_example", - ), + partition_config=CreatePipeTableRequestPartitionConfig(None), path_prefix="path_prefix_example", polling_interval_seconds=1, source_storage_name="source_storage_name_example", @@ -160,8 +152,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Create a new AI Lake pipe table - api_response = api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - pprint(api_response) + api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->create_ai_lake_pipe_table: %s\n" % e) @@ -169,8 +160,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Create a new AI Lake pipe table - api_response = api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) - pprint(api_response) + api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->create_ai_lake_pipe_table: %s\n" % e) ``` @@ -186,7 +176,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -195,7 +185,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -207,7 +197,7 @@ 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) # **delete_ai_lake_pipe_table** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_ai_lake_pipe_table(instance_id, table_name) +> delete_ai_lake_pipe_table(instance_id, table_name) (BETA) Delete an AI Lake pipe table @@ -239,8 +229,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Delete an AI Lake pipe table - api_response = api_instance.delete_ai_lake_pipe_table(instance_id, table_name) - pprint(api_response) + api_instance.delete_ai_lake_pipe_table(instance_id, table_name) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->delete_ai_lake_pipe_table: %s\n" % e) @@ -248,8 +237,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an AI Lake pipe table - api_response = api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) - pprint(api_response) + api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->delete_ai_lake_pipe_table: %s\n" % e) ``` @@ -265,7 +253,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -274,7 +262,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details @@ -382,8 +370,8 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -412,8 +400,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -439,7 +427,7 @@ 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_pipe_table_partition** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) +> refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) (BETA) Refresh a pipe table partition @@ -477,8 +465,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Refresh a pipe table partition - api_response = api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - pprint(api_response) + api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) @@ -486,8 +473,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Refresh a pipe table partition - api_response = api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) - pprint(api_response) + api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakePipeTablesApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) ``` @@ -504,7 +490,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -513,7 +499,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details diff --git a/gooddata-api-client/docs/AILakeServicesOperationsApi.md b/gooddata-api-client/docs/AILakeServicesOperationsApi.md index fa1385e80..157ea3b54 100644 --- a/gooddata-api-client/docs/AILakeServicesOperationsApi.md +++ b/gooddata-api-client/docs/AILakeServicesOperationsApi.md @@ -171,8 +171,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_services_operations_api.AILakeServicesOperationsApi(api_client) - page = "0" # str | Zero-based page number. (optional) if omitted the server will use the default value of "0" - size = "50" # str | Number of items per page. (optional) if omitted the server will use the default value of "50" + page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 + size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 meta_include = [ "metaInclude_example", ] # [str] | (optional) @@ -192,8 +192,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page** | **str**| Zero-based page number. | [optional] if omitted the server will use the default value of "0" - **size** | **str**| Number of items per page. | [optional] if omitted the server will use the default value of "50" + **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 + **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 **meta_include** | **[str]**| | [optional] ### Return type @@ -219,7 +219,7 @@ 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) # **run_ai_lake_service_command** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} run_ai_lake_service_command(service_id, command_name, run_service_command_request) +> run_ai_lake_service_command(service_id, command_name, run_service_command_request) (BETA) Run an AI Lake services command @@ -258,8 +258,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: # (BETA) Run an AI Lake services command - api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request) - pprint(api_response) + api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeServicesOperationsApi->run_ai_lake_service_command: %s\n" % e) @@ -267,8 +266,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Run an AI Lake services command - api_response = api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request, operation_id=operation_id) - pprint(api_response) + api_instance.run_ai_lake_service_command(service_id, command_name, run_service_command_request, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeServicesOperationsApi->run_ai_lake_service_command: %s\n" % e) ``` @@ -285,7 +283,7 @@ Name | Type | Description | Notes ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +void (empty response body) ### Authorization @@ -294,7 +292,7 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details diff --git a/gooddata-api-client/docs/AIObservabilityApi.md b/gooddata-api-client/docs/AIObservabilityApi.md new file mode 100644 index 000000000..660f96b35 --- /dev/null +++ b/gooddata-api-client/docs/AIObservabilityApi.md @@ -0,0 +1,70 @@ +# gooddata_api_client.AIObservabilityApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**reload_observability_layout**](AIObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout + + +# **reload_observability_layout** +> reload_observability_layout() + +Reload the managed AI observability layout + +Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_observability_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_observability_api.AIObservabilityApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Reload the managed AI observability layout + api_instance.reload_observability_layout() + except gooddata_api_client.ApiException as e: + print("Exception when calling AIObservabilityApi->reload_observability_layout: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[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/AbsoluteGranularityDateFilter.md b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md new file mode 100644 index 000000000..9737918b4 --- /dev/null +++ b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md @@ -0,0 +1,13 @@ +# 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, 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. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.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/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md b/gooddata-api-client/docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md new file mode 100644 index 000000000..2f91a0a5c --- /dev/null +++ b/gooddata-api-client/docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md @@ -0,0 +1,18 @@ +# AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataset** | [**AfmObjectIdentifierDataset**](AfmObjectIdentifierDataset.md) | | +**granularity** | **str** | Granularity determining the filtered date attribute and the expected 'from'/'to' format. | +**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" +**_from** | **str, none_type** | Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start. | [optional] +**local_identifier** | **str** | | [optional] +**to** | **str, none_type** | End of the range (including), in the format matching 'granularity'. If omitted, the range 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/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index e7628f93d..75d02810d 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -46,8 +46,8 @@ Method | HTTP request | Description [**delete_workspace_automations**](ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace [**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. [**fact_permissions**](ActionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions -[**forecast**](ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast -[**forecast_result**](ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +[**forecast**](ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast +[**forecast_result**](ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result [**generate_dashboard_summary**](ActionsApi.md#generate_dashboard_summary) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary | [**generate_description**](ActionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object [**generate_logical_model**](ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) @@ -85,13 +85,13 @@ Method | HTTP request | Description [**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_organization_permissions**](ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization [**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 -[**metadata_sync**](ActionsApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -[**metadata_sync_organization**](ActionsApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services +[**metric_permissions**](ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions [**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. @@ -101,6 +101,7 @@ Method | HTTP request | Description [**read_csv_file_manifests**](ActionsApi.md#read_csv_file_manifests) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests | Read CSV file manifests [**register_upload_notification**](ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification [**register_workspace_upload_notification**](ActionsApi.md#register_workspace_upload_notification) | **POST** /api/v1/actions/workspaces/{workspaceId}/uploadNotification | Register an upload notification +[**reload_observability_layout**](ActionsApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout [**remove_targets**](ActionsApi.md#remove_targets) | **POST** /api/v1/actions/ipAllowlistPolicies/{id}/removeTargets | Remove targets from IP allowlist policy [**resolve_all_entitlements**](ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. [**resolve_all_settings_without_workspace**](ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. @@ -172,7 +173,7 @@ with gooddata_api_client.ApiClient() as api_client: ip_allowlist_policy_targets = IpAllowlistPolicyTargets( targets=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], @@ -291,7 +292,7 @@ with gooddata_api_client.ApiClient() as api_client: widgets=[ WidgetDescriptor( filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], title="title_example", widget_id="widget_id_example", @@ -497,7 +498,7 @@ with gooddata_api_client.ApiClient() as api_client: widgets=[ WidgetDescriptor( filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], title="title_example", widget_id="widget_id_example", @@ -1356,7 +1357,7 @@ with gooddata_api_client.ApiClient() as api_client: "exclude_tags_example", ], filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], include_tags=[ "include_tags_example", @@ -1981,6 +1982,7 @@ with gooddata_api_client.ApiClient() as api_client: label="label_id", pattern_filter="pattern_filter_example", sort_order="ASC", + timezone="Europe/Prague", validate_by=[ ValidateByItem( id="id_example", @@ -2117,15 +2119,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), result_spec=ResultSpec( @@ -2155,6 +2149,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # AfmExecution | skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False @@ -2248,6 +2243,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # VisualizationObjectExecution | (optional) @@ -2454,15 +2450,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), types=[ @@ -2615,11 +2603,7 @@ with gooddata_api_client.ApiClient() as api_client: DashboardFilter(), ], dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -2628,13 +2612,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -2722,6 +2707,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -2799,6 +2785,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ) # VisualExportRequest | x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False @@ -2938,20 +2925,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -3031,6 +3011,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -3133,6 +3114,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -3164,6 +3169,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ) # TabularExportRequest | # example passing only required values which don't have defaults set @@ -3232,7 +3240,7 @@ configuration = gooddata_api_client.Configuration( 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 + workspace_id = "workspaceId_example" # str | # example passing only required values which don't have defaults set try: @@ -3248,7 +3256,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| | ### Return type @@ -3694,15 +3702,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), result_spec=ResultSpec( @@ -3732,6 +3732,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # AfmExecution | explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build (optional) @@ -3853,9 +3854,9 @@ No authorization required # **forecast** > SmartFunctionResponse forecast(workspace_id, result_id, forecast_request) -(BETA) Smart functions - Forecast +Smart functions - Forecast -(BETA) Computes forecasted data points from the provided execution result and parameters. +Computes forecasted data points from the provided execution result and parameters. ### Example @@ -3889,7 +3890,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Smart functions - Forecast + # Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -3898,7 +3899,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) Smart functions - Forecast + # Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -3940,9 +3941,9 @@ No authorization required # **forecast_result** > ForecastResult forecast_result(workspace_id, result_id) -(BETA) Smart functions - Forecast Result +Smart functions - Forecast Result -(BETA) Gets forecast result. +Gets forecast result. ### Example @@ -3971,7 +3972,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Smart functions - Forecast Result + # Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -3980,7 +3981,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) Smart functions - Forecast Result + # Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id, offset=offset, limit=limit) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -6161,7 +6162,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) list_llm_provider_models_request = ListLlmProviderModelsRequest( - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # ListLlmProviderModelsRequest | # example passing only required values which don't have defaults set @@ -6375,7 +6376,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) + name = "name=charles" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) # example passing only required values which don't have defaults set try: @@ -6401,7 +6402,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **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 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] ### Return type @@ -6596,7 +6597,7 @@ with gooddata_api_client.ApiClient() as api_client: data_source_permission_assignment = [ DataSourcePermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), permissions=[ @@ -6775,6 +6776,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[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) + +# **manage_metric_permissions** +> manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) + +(BETA) Manage Permissions for a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +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 | + metric_id = "metricId_example" # str | + manage_metric_permissions_request_inner = [ + ManageMetricPermissionsRequestInner(None), + ] # [ManageMetricPermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) 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) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **metric_id** | **str**| | + **manage_metric_permissions_request_inner** | [**[ManageMetricPermissionsRequestInner]**](ManageMetricPermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -6813,7 +6884,7 @@ with gooddata_api_client.ApiClient() as api_client: organization_permission_assignment = [ OrganizationPermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), permissions=[ @@ -6890,7 +6961,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_permission_assignment = [ WorkspacePermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), hierarchy_permissions=[ @@ -7138,12 +7209,10 @@ 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) -# **metadata_sync** -> metadata_sync(workspace_id) +# **metric_permissions** +> MetricPermissions metric_permissions(workspace_id, metric_id) -(BETA) Sync Metadata to other services - -(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. +(BETA) Get Metric Permissions ### Example @@ -7152,6 +7221,7 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.metric_permissions import MetricPermissions 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. @@ -7165,13 +7235,15 @@ 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 | + metric_id = "metricId_example" # str | # example passing only required values which don't have defaults set try: - # (BETA) Sync Metadata to other services - api_instance.metadata_sync(workspace_id) + # (BETA) Get Metric Permissions + api_response = api_instance.metric_permissions(workspace_id, metric_id) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->metadata_sync: %s\n" % e) + print("Exception when calling ActionsApi->metric_permissions: %s\n" % e) ``` @@ -7180,71 +7252,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | + **metric_id** | **str**| | ### Return type -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**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) - -# **metadata_sync_organization** -> metadata_sync_organization() - -(BETA) Sync organization scope Metadata to other services - -(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. - -### 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) - - # example, this endpoint has no required or optional parameters - try: - # (BETA) Sync organization scope Metadata to other services - api_instance.metadata_sync_organization() - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->metadata_sync_organization: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) +[**MetricPermissions**](MetricPermissions.md) ### Authorization @@ -7253,7 +7265,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details @@ -7313,7 +7325,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], granularity="HOUR", measures=[ @@ -7946,6 +7958,67 @@ 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) +# **reload_observability_layout** +> reload_observability_layout() + +Reload the managed AI observability layout + +Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched. + +### 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) + + # example, this endpoint has no required or optional parameters + try: + # Reload the managed AI observability layout + api_instance.reload_observability_layout() + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->reload_observability_layout: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[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_targets** > remove_targets(id, ip_allowlist_policy_targets) @@ -7975,7 +8048,7 @@ with gooddata_api_client.ApiClient() as api_client: ip_allowlist_policy_targets = IpAllowlistPolicyTargets( targets=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], @@ -8671,7 +8744,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Execution result was found and returned. | - | +**200** | Execution result was found and returned. | * X-GDC-RESULT-TOTAL-ROWS - Total number of data rows in the full result.
| [[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) @@ -9324,7 +9397,7 @@ configuration = gooddata_api_client.Configuration( 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 + workspace_id = "workspaceId_example" # str | # example passing only required values which don't have defaults set try: @@ -9340,7 +9413,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| | ### Return type @@ -9394,6 +9467,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) data_source_id = "myPostgres" # str | Data source id test_request = TestRequest( + authentication_type="USERNAME_PASSWORD", client_id="client_id_example", client_secret="client_secret_example", parameters=[ @@ -9479,6 +9553,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) test_definition_request = TestDefinitionRequest( + authentication_type="USERNAME_PASSWORD", client_id="client_id_example", client_secret="client_secret_example", parameters=[ @@ -9565,7 +9640,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) notification_channel_id = "notificationChannelId_example" # str | test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), external_recipients=[ AutomationExternalRecipient( email="email_example", @@ -9656,7 +9731,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # TestLlmProviderDefinitionRequest | # example passing only required values which don't have defaults set @@ -9733,7 +9808,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # TestLlmProviderByIdRequest | (optional) # example passing only required values which don't have defaults set @@ -9813,7 +9888,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), external_recipients=[ AutomationExternalRecipient( email="email_example", @@ -9957,7 +10032,7 @@ with gooddata_api_client.ApiClient() as api_client: trigger_automation_request = TriggerAutomationRequest( automation=AdHocAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -9987,15 +10062,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -10013,11 +10080,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -10026,13 +10089,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -10063,6 +10127,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -10134,20 +10199,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -10169,6 +10227,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -10195,6 +10254,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -10226,6 +10309,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -10237,6 +10323,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], diff --git a/gooddata-api-client/docs/AggregateKeyConfig.md b/gooddata-api-client/docs/AggregateKeyConfig.md index 7124bbab1..ae0248dc0 100644 --- a/gooddata-api-client/docs/AggregateKeyConfig.md +++ b/gooddata-api-client/docs/AggregateKeyConfig.md @@ -5,6 +5,7 @@ Aggregate key model — pre-aggregates rows sharing the same key columns. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "aggregate" **columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/AnalyticsCatalogCreatedBy.md b/gooddata-api-client/docs/AnalyticsCatalogCreatedBy.md index a03360a97..be2a73f83 100644 --- a/gooddata-api-client/docs/AnalyticsCatalogCreatedBy.md +++ b/gooddata-api-client/docs/AnalyticsCatalogCreatedBy.md @@ -1,11 +1,12 @@ # AnalyticsCatalogCreatedBy +List of users who created catalog objects in the workspace hierarchy. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reasoning** | **str** | Reasoning for error states | -**users** | [**[AnalyticsCatalogUser]**](AnalyticsCatalogUser.md) | Users who created any object in the catalog | +**reasoning** | **str** | Reserved for future use. Always empty string in the current implementation. | +**users** | [**[AnalyticsCatalogUser]**](AnalyticsCatalogUser.md) | Distinct users who have created at least one catalog object. | **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/AnalyticsCatalogTags.md b/gooddata-api-client/docs/AnalyticsCatalogTags.md index bf5382897..2b91cd260 100644 --- a/gooddata-api-client/docs/AnalyticsCatalogTags.md +++ b/gooddata-api-client/docs/AnalyticsCatalogTags.md @@ -1,10 +1,11 @@ # AnalyticsCatalogTags +List of distinct catalog tags aggregated across the workspace hierarchy. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tags** | **[str]** | | +**tags** | **[str]** | Sorted, distinct tag strings found in the workspace hierarchy. | **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/AnalyticsCatalogUser.md b/gooddata-api-client/docs/AnalyticsCatalogUser.md index eee96e247..59118c514 100644 --- a/gooddata-api-client/docs/AnalyticsCatalogUser.md +++ b/gooddata-api-client/docs/AnalyticsCatalogUser.md @@ -1,13 +1,13 @@ # AnalyticsCatalogUser -Users who created any object in the catalog +A user who has created one or more catalog objects. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstname** | **str** | First name of the user who created any objects | -**lastname** | **str** | Last name of the user who created any objects | -**user_id** | **str** | User ID of the user who created any objects | +**firstname** | **str** | User first name. | +**lastname** | **str** | User last name. | +**user_id** | **str** | User identifier. | **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/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index 89e48b897..e178c8c17 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -208,7 +208,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -276,7 +276,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", diff --git a/gooddata-api-client/docs/AppearanceApi.md b/gooddata-api-client/docs/AppearanceApi.md index 8d7f0edd7..0538c812f 100644 --- a/gooddata-api-client/docs/AppearanceApi.md +++ b/gooddata-api-client/docs/AppearanceApi.md @@ -6,16 +6,28 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create_entity_color_palettes**](AppearanceApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes [**create_entity_themes**](AppearanceApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming +[**create_entity_workspace_color_palettes**](AppearanceApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette +[**create_entity_workspace_themes**](AppearanceApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme [**delete_entity_color_palettes**](AppearanceApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette [**delete_entity_themes**](AppearanceApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming +[**delete_entity_workspace_color_palettes**](AppearanceApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette +[**delete_entity_workspace_themes**](AppearanceApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme [**get_all_entities_color_palettes**](AppearanceApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes [**get_all_entities_themes**](AppearanceApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities +[**get_all_entities_workspace_color_palettes**](AppearanceApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes +[**get_all_entities_workspace_themes**](AppearanceApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes [**get_entity_color_palettes**](AppearanceApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette [**get_entity_themes**](AppearanceApi.md#get_entity_themes) | **GET** /api/v1/entities/themes/{id} | Get Theming +[**get_entity_workspace_color_palettes**](AppearanceApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette +[**get_entity_workspace_themes**](AppearanceApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme [**patch_entity_color_palettes**](AppearanceApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette [**patch_entity_themes**](AppearanceApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming +[**patch_entity_workspace_color_palettes**](AppearanceApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette +[**patch_entity_workspace_themes**](AppearanceApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme [**update_entity_color_palettes**](AppearanceApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette [**update_entity_themes**](AppearanceApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming +[**update_entity_workspace_color_palettes**](AppearanceApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette +[**update_entity_workspace_themes**](AppearanceApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme # **create_entity_color_palettes** @@ -160,6 +172,186 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + +Post Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPaletteInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->create_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->create_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + +Post Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->create_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->create_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -259,10 +451,796 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete Theming - api_instance.delete_entity_themes(id) + # Delete Theming + api_instance.delete_entity_themes(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->delete_entity_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_workspace_color_palettes** +> delete_entity_workspace_color_palettes(workspace_id, object_id) + +Delete a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Color Palette + api_instance.delete_entity_workspace_color_palettes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->delete_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_workspace_themes** +> delete_entity_workspace_themes(workspace_id, object_id) + +Delete a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Theme + api_instance.delete_entity_workspace_themes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->delete_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_color_palettes** +> JsonApiColorPaletteOutList get_all_entities_color_palettes() + +Get all Color Pallettes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +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 = appearance_api.AppearanceApi(api_client) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Color Pallettes + api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiColorPaletteOutList**](JsonApiColorPaletteOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_all_entities_themes** +> JsonApiThemeOutList get_all_entities_themes() + +Get all Theming entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +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 = appearance_api.AppearanceApi(api_client) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Theming entities + api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiThemeOutList**](JsonApiThemeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_all_entities_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutList get_all_entities_workspace_color_palettes(workspace_id) + +Get all Workspace Color Palettes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutList**](JsonApiWorkspaceColorPaletteOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_all_entities_workspace_themes** +> JsonApiWorkspaceThemeOutList get_all_entities_workspace_themes(workspace_id) + +Get all Workspace Themes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_all_entities_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutList**](JsonApiWorkspaceThemeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_color_palettes** +> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) + +Get Color Pallette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +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 = appearance_api.AppearanceApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get Color Pallette + api_response = api_instance.get_entity_color_palettes(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Color Pallette + api_response = api_instance.get_entity_color_palettes(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_themes** +> JsonApiThemeOutDocument get_entity_themes(id) + +Get Theming + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +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 = appearance_api.AppearanceApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get Theming + api_response = api_instance.get_entity_themes(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Theming + api_response = api_instance.get_entity_themes(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument get_entity_workspace_color_palettes(workspace_id, object_id) + +Get a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument get_entity_workspace_themes(workspace_id, object_id) + +Get a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import appearance_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +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 = appearance_api.AppearanceApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->get_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->delete_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->get_entity_workspace_themes: %s\n" % e) ``` @@ -270,11 +1248,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) ### Authorization @@ -283,21 +1265,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Successfully deleted | - | +**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) -# **get_all_entities_color_palettes** -> JsonApiColorPaletteOutList get_all_entities_color_palettes() +# **patch_entity_color_palettes** +> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) -Get all Color Pallettes +Patch Color Pallette ### Example @@ -306,7 +1288,8 @@ Get all Color Pallettes import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument 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. @@ -319,24 +1302,35 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_color_palette_patch_document = JsonApiColorPalettePatchDocument( + data=JsonApiColorPalettePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="colorPalette", + ), + ) # JsonApiColorPalettePatchDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Color Pallette + api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Color Pallettes - api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Patch Color Pallette + api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_all_entities_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) ``` @@ -344,15 +1338,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiColorPaletteOutList**](JsonApiColorPaletteOutList.md) +[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) ### Authorization @@ -360,7 +1352,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -372,10 +1364,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_themes** -> JsonApiThemeOutList get_all_entities_themes() +# **patch_entity_themes** +> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document) -Get all Theming entities +Patch Theming ### Example @@ -384,7 +1376,8 @@ Get all Theming entities import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument 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. @@ -397,24 +1390,35 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_theme_patch_document = JsonApiThemePatchDocument( + data=JsonApiThemePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="theme", + ), + ) # JsonApiThemePatchDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Theming + api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Theming entities - api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Patch Theming + api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_all_entities_themes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) ``` @@ -422,15 +1426,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiThemeOutList**](JsonApiThemeOutList.md) +[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) ### Authorization @@ -438,7 +1440,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -450,10 +1452,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_color_palettes** -> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) +# **patch_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) -Get Color Pallette +Patch a Workspace Color Palette ### Example @@ -462,7 +1464,8 @@ Get Color Pallette import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument 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. @@ -475,25 +1478,36 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_color_palette_patch_document = JsonApiWorkspaceColorPalettePatchDocument( + data=JsonApiWorkspaceColorPalettePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPalettePatchDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id) + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id, filter=filter) + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_workspace_color_palettes: %s\n" % e) ``` @@ -501,12 +1515,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_color_palette_patch_document** | [**JsonApiWorkspaceColorPalettePatchDocument**](JsonApiWorkspaceColorPalettePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) ### Authorization @@ -514,7 +1530,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -526,10 +1542,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_themes** -> JsonApiThemeOutDocument get_entity_themes(id) +# **patch_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) -Get Theming +Patch a Workspace Theme ### Example @@ -538,7 +1554,8 @@ Get Theming import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument 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. @@ -551,25 +1568,36 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_theme_patch_document = JsonApiWorkspaceThemePatchDocument( + data=JsonApiWorkspaceThemePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemePatchDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get Theming - api_response = api_instance.get_entity_themes(id) + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_workspace_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Theming - api_response = api_instance.get_entity_themes(id, filter=filter) + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->get_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->patch_entity_workspace_themes: %s\n" % e) ``` @@ -577,12 +1605,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_theme_patch_document** | [**JsonApiWorkspaceThemePatchDocument**](JsonApiWorkspaceThemePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) ### Authorization @@ -590,7 +1620,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -602,10 +1632,10 @@ 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) -# **patch_entity_color_palettes** -> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) +# **update_entity_color_palettes** +> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document) -Patch Color Pallette +Put Color Pallette ### Example @@ -614,7 +1644,7 @@ Patch Color Pallette import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -629,34 +1659,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_patch_document = JsonApiColorPalettePatchDocument( - data=JsonApiColorPalettePatch( - attributes=JsonApiColorPalettePatchAttributes( + json_api_color_palette_in_document = JsonApiColorPaletteInDocument( + data=JsonApiColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( content={}, name="name_example", ), id="id1", type="colorPalette", ), - ) # JsonApiColorPalettePatchDocument | + ) # JsonApiColorPaletteInDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) + # Put Color Pallette + api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + # Put Color Pallette + api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) ``` @@ -665,7 +1695,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -690,10 +1720,10 @@ 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) -# **patch_entity_themes** -> JsonApiThemeOutDocument patch_entity_themes(id, json_api_theme_patch_document) +# **update_entity_themes** +> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document) -Patch Theming +Put Theming ### Example @@ -702,7 +1732,7 @@ Patch Theming import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -717,34 +1747,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_patch_document = JsonApiThemePatchDocument( - data=JsonApiThemePatch( - attributes=JsonApiColorPalettePatchAttributes( + json_api_theme_in_document = JsonApiThemeInDocument( + data=JsonApiThemeIn( + attributes=JsonApiColorPaletteInAttributes( content={}, name="name_example", ), id="id1", type="theme", ), - ) # JsonApiThemePatchDocument | + ) # JsonApiThemeInDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch Theming - api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document) + # Put Theming + api_response = api_instance.update_entity_themes(id, json_api_theme_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Theming - api_response = api_instance.patch_entity_themes(id, json_api_theme_patch_document, filter=filter) + # Put Theming + api_response = api_instance.update_entity_themes(id, json_api_theme_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->patch_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) ``` @@ -753,7 +1783,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_theme_patch_document** | [**JsonApiThemePatchDocument**](JsonApiThemePatchDocument.md)| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -778,10 +1808,10 @@ 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) -# **update_entity_color_palettes** -> JsonApiColorPaletteOutDocument update_entity_color_palettes(id, json_api_color_palette_in_document) +# **update_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) -Put Color Pallette +Put a Workspace Color Palette ### Example @@ -790,8 +1820,8 @@ Put Color Pallette import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_color_palette_in_document import JsonApiColorPaletteInDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument 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. @@ -804,35 +1834,36 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_color_palette_in_document = JsonApiColorPaletteInDocument( - data=JsonApiColorPaletteIn( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( attributes=JsonApiColorPaletteInAttributes( content={}, name="name_example", ), id="id1", - type="colorPalette", + type="workspaceColorPalette", ), - ) # JsonApiColorPaletteInDocument | + ) # JsonApiWorkspaceColorPaletteInDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Put Color Pallette - api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document) + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put Color Pallette - api_response = api_instance.update_entity_color_palettes(id, json_api_color_palette_in_document, filter=filter) + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_color_palettes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_workspace_color_palettes: %s\n" % e) ``` @@ -840,13 +1871,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_in_document** | [**JsonApiColorPaletteInDocument**](JsonApiColorPaletteInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) ### Authorization @@ -866,10 +1898,10 @@ 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) -# **update_entity_themes** -> JsonApiThemeOutDocument update_entity_themes(id, json_api_theme_in_document) +# **update_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) -Put Theming +Put a Workspace Theme ### Example @@ -878,8 +1910,8 @@ Put Theming import time import gooddata_api_client from gooddata_api_client.api import appearance_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument 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. @@ -892,35 +1924,36 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = appearance_api.AppearanceApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( attributes=JsonApiColorPaletteInAttributes( content={}, name="name_example", ), id="id1", - type="theme", + type="workspaceTheme", ), - ) # JsonApiThemeInDocument | + ) # JsonApiWorkspaceThemeInDocument | filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Put Theming - api_response = api_instance.update_entity_themes(id, json_api_theme_in_document) + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_workspace_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put Theming - api_response = api_instance.update_entity_themes(id, json_api_theme_in_document, filter=filter) + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AppearanceApi->update_entity_themes: %s\n" % e) + print("Exception when calling AppearanceApi->update_entity_workspace_themes: %s\n" % e) ``` @@ -928,13 +1961,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) ### Authorization diff --git a/gooddata-api-client/docs/AssigneeIdentifier.md b/gooddata-api-client/docs/AssigneeIdentifier.md index 4ab713a35..b2b68a2a7 100644 --- a/gooddata-api-client/docs/AssigneeIdentifier.md +++ b/gooddata-api-client/docs/AssigneeIdentifier.md @@ -5,7 +5,7 @@ Identifier of a user or user-group. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | +**id** | **str** | Identifier of the assignee. | **type** | **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/AutomationAlert.md b/gooddata-api-client/docs/AutomationAlert.md index 32736e5de..7f0952654 100644 --- a/gooddata-api-client/docs/AutomationAlert.md +++ b/gooddata-api-client/docs/AutomationAlert.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**condition** | [**AutomationAlertCondition**](AutomationAlertCondition.md) | | +**condition** | [**AlertCondition**](AlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | **interval** | **str** | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] **trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. | [optional] if omitted the server will use the default value of "ALWAYS" diff --git a/gooddata-api-client/docs/AutomationControllerApi.md b/gooddata-api-client/docs/AutomationControllerApi.md index 811819f26..718699ff4 100644 --- a/gooddata-api-client/docs/AutomationControllerApi.md +++ b/gooddata-api-client/docs/AutomationControllerApi.md @@ -74,15 +74,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -97,11 +89,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -110,13 +98,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -146,6 +135,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -213,20 +203,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -247,6 +230,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -274,6 +258,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -305,6 +313,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -318,6 +329,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -718,15 +730,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -741,11 +745,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -754,13 +754,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -790,6 +791,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -857,20 +859,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -891,6 +886,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -918,6 +914,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -949,6 +969,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -962,6 +985,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -1211,15 +1235,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -1234,11 +1250,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -1247,13 +1259,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -1283,6 +1296,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -1350,20 +1364,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -1384,6 +1391,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -1411,6 +1419,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -1442,6 +1474,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -1455,6 +1490,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], diff --git a/gooddata-api-client/docs/AutomationNotification.md b/gooddata-api-client/docs/AutomationNotification.md index 78fb7c72e..9b133c096 100644 --- a/gooddata-api-client/docs/AutomationNotification.md +++ b/gooddata-api-client/docs/AutomationNotification.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**WebhookMessage**](WebhookMessage.md) | | -**type** | **str** | | +**type** | **str** | | defaults to "AUTOMATION" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 402696bf9..c1e07a935 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -91,15 +91,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -114,11 +106,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -127,13 +115,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -163,6 +152,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -230,20 +220,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -264,6 +247,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -291,6 +275,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -322,6 +330,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -335,6 +346,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -1040,15 +1052,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -1063,11 +1067,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -1076,13 +1076,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -1112,6 +1113,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -1179,20 +1181,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -1213,6 +1208,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -1240,6 +1236,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -1271,6 +1291,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -1284,6 +1307,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -1744,7 +1768,7 @@ with gooddata_api_client.ApiClient() as api_client: declarative_automation = [ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -1774,15 +1798,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -1805,11 +1821,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -1818,13 +1830,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -1863,6 +1876,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -1939,20 +1953,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -1979,6 +1986,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -2006,6 +2014,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -2037,6 +2069,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -2050,6 +2085,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -2125,7 +2161,7 @@ with gooddata_api_client.ApiClient() as api_client: trigger_automation_request = TriggerAutomationRequest( automation=AdHocAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -2155,15 +2191,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -2181,11 +2209,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -2194,13 +2218,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -2231,6 +2256,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -2302,20 +2328,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -2337,6 +2356,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -2363,6 +2383,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -2394,6 +2438,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -2405,6 +2452,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -3051,15 +3099,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -3074,11 +3114,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -3087,13 +3123,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -3123,6 +3160,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -3190,20 +3228,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -3224,6 +3255,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -3251,6 +3283,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -3282,6 +3338,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -3295,6 +3354,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], diff --git a/gooddata-api-client/docs/CacheRetention.md b/gooddata-api-client/docs/CacheRetention.md new file mode 100644 index 000000000..5ed11d831 --- /dev/null +++ b/gooddata-api-client/docs/CacheRetention.md @@ -0,0 +1,15 @@ +# CacheRetention + +Determines when the cached results coming from a particular data source expire. The shape is selected by the `type` property. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The cache retention type. | [optional] if omitted the server will use the default value of "SCHEDULE" +**validity_period** | **str** | How long the cached results stay valid after they were computed. | [optional] +**schedule** | [**CacheRetentionSchedule**](CacheRetentionSchedule.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/CacheRetentionSchedule.md b/gooddata-api-client/docs/CacheRetentionSchedule.md new file mode 100644 index 000000000..9a988ff1e --- /dev/null +++ b/gooddata-api-client/docs/CacheRetentionSchedule.md @@ -0,0 +1,14 @@ +# CacheRetentionSchedule + +A schedule determining when the cached results of a data source expire. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron** | **str** | Cron expression determining when the cached results expire. | +**timezone** | **str, none_type** | Timezone the cron expression is evaluated in. Defaults to UTC when not set. | [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/CalendarDefinition.md b/gooddata-api-client/docs/CalendarDefinition.md new file mode 100644 index 000000000..054b3b578 --- /dev/null +++ b/gooddata-api-client/docs/CalendarDefinition.md @@ -0,0 +1,14 @@ +# CalendarDefinition + +Fiscal calendar definition. The concrete shape is selected by the `type` discriminator. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_tables** | [**{str: (CalendarTableReference,)}**](CalendarTableReference.md) | Custom fiscal calendar table per data source ID. | [optional] +**month_offset** | **int** | Number of months the fiscal year start is shifted relative to the Gregorian year. | [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/CalendarGranularity.md b/gooddata-api-client/docs/CalendarGranularity.md new file mode 100644 index 000000000..4a9e1be4a --- /dev/null +++ b/gooddata-api-client/docs/CalendarGranularity.md @@ -0,0 +1,14 @@ +# CalendarGranularity + +A fiscal granularity enabled in a calendar together with its title prefix. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**granularity** | **str** | Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. | +**prefix** | **str** | Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. | +**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/CalendarTableReference.md b/gooddata-api-client/docs/CalendarTableReference.md new file mode 100644 index 000000000..f45b714ba --- /dev/null +++ b/gooddata-api-client/docs/CalendarTableReference.md @@ -0,0 +1,14 @@ +# CalendarTableReference + +Reference to a custom fiscal calendar table in a data source. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **[str]** | Path to the fiscal calendar table. | +**version** | **str** | Version of the fiscal calendar table structure. | +**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/CertificationInfo.md b/gooddata-api-client/docs/CertificationInfo.md new file mode 100644 index 000000000..d3fa8dbb2 --- /dev/null +++ b/gooddata-api-client/docs/CertificationInfo.md @@ -0,0 +1,14 @@ +# CertificationInfo + +Certification state of the object. Who certified and when are never exposed here. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | Certification status, e.g. CERTIFIED. | +**certification_message** | **str** | Optional message describing the certification. | [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/ChangeAnalysisParams.md b/gooddata-api-client/docs/ChangeAnalysisParams.md index 1ffdedf57..541b74d5c 100644 --- a/gooddata-api-client/docs/ChangeAnalysisParams.md +++ b/gooddata-api-client/docs/ChangeAnalysisParams.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **analyzed_period** | **str** | The analyzed time period | **attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to analyze for significant changes | **date_attribute** | [**AttributeItem**](AttributeItem.md) | | -**filters** | [**[ChangeAnalysisParamsFiltersInner]**](ChangeAnalysisParamsFiltersInner.md) | Optional filters to apply | +**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Optional filters to apply | **measure** | [**MeasureItem**](MeasureItem.md) | | **measure_title** | **str** | The title of the measure being analyzed | **reference_period** | **str** | The reference time period | diff --git a/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md b/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md deleted file mode 100644 index 0c4ac924c..000000000 --- a/gooddata-api-client/docs/ChangeAnalysisParamsFiltersInner.md +++ /dev/null @@ -1,22 +0,0 @@ -# ChangeAnalysisParamsFiltersInner - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comparison_measure_value_filter** | [**ComparisonMeasureValueFilterComparisonMeasureValueFilter**](ComparisonMeasureValueFilterComparisonMeasureValueFilter.md) | | [optional] -**range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] -**compound_measure_value_filter** | [**CompoundMeasureValueFilterCompoundMeasureValueFilter**](CompoundMeasureValueFilterCompoundMeasureValueFilter.md) | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] -**absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] -**relative_date_filter** | [**RelativeDateFilterRelativeDateFilter**](RelativeDateFilterRelativeDateFilter.md) | | [optional] -**all_time_date_filter** | [**AllTimeDateFilterAllTimeDateFilter**](AllTimeDateFilterAllTimeDateFilter.md) | | [optional] -**negative_attribute_filter** | [**NegativeAttributeFilterNegativeAttributeFilter**](NegativeAttributeFilterNegativeAttributeFilter.md) | | [optional] -**positive_attribute_filter** | [**PositiveAttributeFilterPositiveAttributeFilter**](PositiveAttributeFilterPositiveAttributeFilter.md) | | [optional] -**match_attribute_filter** | [**MatchAttributeFilterMatchAttributeFilter**](MatchAttributeFilterMatchAttributeFilter.md) | | [optional] -**inline** | [**InlineFilterDefinitionInline**](InlineFilterDefinitionInline.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/ChangeAnalysisRequest.md b/gooddata-api-client/docs/ChangeAnalysisRequest.md index 368939fab..d813a8412 100644 --- a/gooddata-api-client/docs/ChangeAnalysisRequest.md +++ b/gooddata-api-client/docs/ChangeAnalysisRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered. | [optional] **aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Auxiliary measures | [optional] **exclude_tags** | **[str]** | Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes. | [optional] -**filters** | [**[ChangeAnalysisParamsFiltersInner]**](ChangeAnalysisParamsFiltersInner.md) | Optional filters to apply. | [optional] +**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Optional filters to apply. | [optional] **include_tags** | **[str]** | Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes. | [optional] **use_smart_attribute_selection** | **bool** | Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided. | [optional] if omitted the server will use the default value of False **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/ColumnPartitionConfig.md b/gooddata-api-client/docs/ColumnPartitionConfig.md index 8c75fae7c..d71a7fab2 100644 --- a/gooddata-api-client/docs/ColumnPartitionConfig.md +++ b/gooddata-api-client/docs/ColumnPartitionConfig.md @@ -6,6 +6,7 @@ Partition by column expression. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **columns** | **[str]** | Columns to partition by. | +**type** | **str** | | defaults to "column" **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/CompoundMeasureValueFilterCompoundMeasureValueFilter.md b/gooddata-api-client/docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md index 33c8531cb..c10a61892 100644 --- a/gooddata-api-client/docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md +++ b/gooddata-api-client/docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**conditions** | [**[MeasureValueCondition]**](MeasureValueCondition.md) | List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. | **measure** | [**AfmIdentifier**](AfmIdentifier.md) | | **apply_on_result** | **bool** | | [optional] +**conditions** | [**[MeasureValueCondition]**](MeasureValueCondition.md) | List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. | [optional] **dimensionality** | [**[AfmIdentifier]**](AfmIdentifier.md) | References to the attributes to be used when filtering. | [optional] **local_identifier** | **str** | | [optional] **treat_null_values_as** | **float** | A value that will be substituted for null values in the metric for the comparisons. | [optional] diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index 223c90c70..723db5d67 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -159,7 +159,7 @@ with gooddata_api_client.ApiClient() as api_client: "exclude_tags_example", ], filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], include_tags=[ "include_tags_example", @@ -408,6 +408,7 @@ with gooddata_api_client.ApiClient() as api_client: label="label_id", pattern_filter="pattern_filter_example", sort_order="ASC", + timezone="Europe/Prague", validate_by=[ ValidateByItem( id="id_example", @@ -544,15 +545,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), result_spec=ResultSpec( @@ -582,6 +575,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # AfmExecution | skip_cache = False # bool | Ignore all caches during execution of current request. (optional) if omitted the server will use the default value of False @@ -675,6 +669,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # VisualizationObjectExecution | (optional) @@ -881,15 +876,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), types=[ @@ -1009,15 +996,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), result_spec=ResultSpec( @@ -1047,6 +1026,7 @@ with gooddata_api_client.ApiClient() as api_client: settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), ) # AfmExecution | explain_type = "MAQL" # str | Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build (optional) @@ -1322,7 +1302,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], granularity="HOUR", measures=[ @@ -1702,7 +1682,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Execution result was found and returned. | - | +**200** | Execution result was found and returned. | * X-GDC-RESULT-TOTAL-ROWS - Total number of data rows in the full result.
| [[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/CreatePipeTableRequest.md b/gooddata-api-client/docs/CreatePipeTableRequest.md index 6edf97d83..edc2d4cef 100644 --- a/gooddata-api-client/docs/CreatePipeTableRequest.md +++ b/gooddata-api-client/docs/CreatePipeTableRequest.md @@ -11,10 +11,10 @@ Name | Type | Description | Notes **aggregation_overrides** | **{str: (str,)}** | Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types. | [optional] **column_expressions** | [**{str: (ColumnExpression,)}**](ColumnExpression.md) | Per-target-column projection overrides. Each entry emits `<function>(<column>) AS <key>` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns). | [optional] **column_overrides** | **{str: (str,)}** | Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference. | [optional] -**distribution_config** | [**DistributionConfig**](DistributionConfig.md) | | [optional] -**key_config** | [**KeyConfig**](KeyConfig.md) | | [optional] +**distribution_config** | [**CreatePipeTableRequestDistributionConfig**](CreatePipeTableRequestDistributionConfig.md) | | [optional] +**key_config** | [**CreatePipeTableRequestKeyConfig**](CreatePipeTableRequestKeyConfig.md) | | [optional] **max_varchar_length** | **int** | Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap. | [optional] -**partition_config** | [**PartitionConfig**](PartitionConfig.md) | | [optional] +**partition_config** | [**CreatePipeTableRequestPartitionConfig**](CreatePipeTableRequestPartitionConfig.md) | | [optional] **polling_interval_seconds** | **int** | How often (in seconds) the pipe polls for new files. 0 or null = use server default. | [optional] **table_properties** | **{str: (str,)}** | CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}. | [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/PipeTableDistributionConfig.md b/gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md similarity index 81% rename from gooddata-api-client/docs/PipeTableDistributionConfig.md rename to gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md index 5550b6711..9a6e14e19 100644 --- a/gooddata-api-client/docs/PipeTableDistributionConfig.md +++ b/gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md @@ -1,4 +1,4 @@ -# PipeTableDistributionConfig +# CreatePipeTableRequestDistributionConfig ## Properties @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **buckets** | **int** | Number of random distribution buckets. Defaults to 1. | [optional] **columns** | **[str]** | Columns to distribute by. Defaults to first column. | [optional] +**type** | **str** | | [optional] if omitted the server will use the default value of "random" **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/DeclarativeParameterContent.md b/gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md similarity index 66% rename from gooddata-api-client/docs/DeclarativeParameterContent.md rename to gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md index 6565cc2a8..5ba2ee78e 100644 --- a/gooddata-api-client/docs/DeclarativeParameterContent.md +++ b/gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md @@ -1,12 +1,11 @@ -# DeclarativeParameterContent +# CreatePipeTableRequestKeyConfig ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | The parameter type. | defaults to "STRING" -**constraints** | [**StringConstraints**](StringConstraints.md) | | [optional] -**default_value** | **str** | | [optional] +**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] +**type** | **str** | | [optional] if omitted the server will use the default value of "unique" **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/PipeTablePartitionConfig.md b/gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md similarity index 83% rename from gooddata-api-client/docs/PipeTablePartitionConfig.md rename to gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md index c10a37f4e..0703702f3 100644 --- a/gooddata-api-client/docs/PipeTablePartitionConfig.md +++ b/gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md @@ -1,10 +1,11 @@ -# PipeTablePartitionConfig +# CreatePipeTableRequestPartitionConfig ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **columns** | **[str]** | Columns to partition by. | [optional] +**type** | **str** | | [optional] if omitted the server will use the default value of "timeSlice" **column** | **str** | Column to partition on. | [optional] **unit** | **str** | Date/time unit for partition granularity | [optional] **slices** | **int** | How many units per slice. | [optional] diff --git a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md b/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md index ad5908c7b..7f6c7d855 100644 --- a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md +++ b/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md @@ -4,13 +4,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**dimensionality** | **[str]** | | [optional] **exclude** | **[str]** | | [optional] **using** | **str** | | [optional] **include** | **[str]** | | [optional] **_from** | **int** | | [optional] **to** | **int** | | [optional] **granularity** | **str** | | [optional] -**ranking_filter** | [**RankingFilterRankingFilter**](RankingFilterRankingFilter.md) | | [optional] +**measures** | **[str]** | | [optional] +**operator** | **str** | | [optional] +**value** | **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/CustomCalendarDefinition.md b/gooddata-api-client/docs/CustomCalendarDefinition.md new file mode 100644 index 000000000..209298101 --- /dev/null +++ b/gooddata-api-client/docs/CustomCalendarDefinition.md @@ -0,0 +1,14 @@ +# CustomCalendarDefinition + +Calendar backed by custom fiscal calendar tables defined per data source. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_tables** | [**{str: (CalendarTableReference,)}**](CalendarTableReference.md) | Custom fiscal calendar table per data source ID. | +**type** | **str** | | defaults to "custom" +**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/CustomCalendarDefinitionAllOf.md b/gooddata-api-client/docs/CustomCalendarDefinitionAllOf.md new file mode 100644 index 000000000..86382a15b --- /dev/null +++ b/gooddata-api-client/docs/CustomCalendarDefinitionAllOf.md @@ -0,0 +1,12 @@ +# CustomCalendarDefinitionAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_tables** | [**{str: (CalendarTableReference,)}**](CalendarTableReference.md) | Custom fiscal calendar table per data source ID. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/DashboardMeasureValueFilterDashboardMeasureValueFilter.md b/gooddata-api-client/docs/DashboardMeasureValueFilterDashboardMeasureValueFilter.md index 789ae7217..539ce97b5 100644 --- a/gooddata-api-client/docs/DashboardMeasureValueFilterDashboardMeasureValueFilter.md +++ b/gooddata-api-client/docs/DashboardMeasureValueFilterDashboardMeasureValueFilter.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**conditions** | [**[DashboardCompoundConditionItem]**](DashboardCompoundConditionItem.md) | | **measure** | [**IdentifierRef**](IdentifierRef.md) | | +**conditions** | [**[DashboardCompoundConditionItem]**](DashboardCompoundConditionItem.md) | | [optional] **dimensionality** | [**[IdentifierRef]**](IdentifierRef.md) | | [optional] **local_identifier** | **str** | | [optional] **title** | **str** | | [optional] diff --git a/gooddata-api-client/docs/DashboardTabularExportRequest.md b/gooddata-api-client/docs/DashboardTabularExportRequest.md index 92f4fabde..d8e421cf8 100644 --- a/gooddata-api-client/docs/DashboardTabularExportRequest.md +++ b/gooddata-api-client/docs/DashboardTabularExportRequest.md @@ -8,9 +8,10 @@ Name | Type | Description | Notes **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested tabular export type. | **dashboard_filters_override** | [**[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] -**dashboard_parameters_override** | [**[DashboardParameterValue]**](DashboardParameterValue.md) | Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides. | [optional] +**dashboard_parameters_override** | [**[ParameterValue]**](ParameterValue.md) | Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides. | [optional] **dashboard_tabs_filters_overrides** | **{str: ([DashboardFilter],)}** | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | [optional] -**dashboard_tabs_parameters_overrides** | **{str: ([DashboardParameterValue],)}** | Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display. | [optional] +**dashboard_tabs_parameters_overrides** | **{str: ([ParameterValue],)}** | Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display. | [optional] +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] **widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [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/DashboardTabularExportRequestV2.md b/gooddata-api-client/docs/DashboardTabularExportRequestV2.md index 93e8ad5cf..5745753b3 100644 --- a/gooddata-api-client/docs/DashboardTabularExportRequestV2.md +++ b/gooddata-api-client/docs/DashboardTabularExportRequestV2.md @@ -9,9 +9,10 @@ Name | Type | Description | Notes **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Requested tabular export type. | **dashboard_filters_override** | [**[DashboardFilter]**](DashboardFilter.md) | List of filters that will be used instead of the default dashboard filters. | [optional] -**dashboard_parameters_override** | [**[DashboardParameterValue]**](DashboardParameterValue.md) | Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides. | [optional] +**dashboard_parameters_override** | [**[ParameterValue]**](ParameterValue.md) | Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides. | [optional] **dashboard_tabs_filters_overrides** | **{str: ([DashboardFilter],)}** | Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab. | [optional] -**dashboard_tabs_parameters_overrides** | **{str: ([DashboardParameterValue],)}** | Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display. | [optional] +**dashboard_tabs_parameters_overrides** | **{str: ([ParameterValue],)}** | Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display. | [optional] +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **settings** | [**DashboardExportSettings**](DashboardExportSettings.md) | | [optional] **widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [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/DataSourceControllerApi.md b/gooddata-api-client/docs/DataSourceControllerApi.md index 1f18331fe..1989010eb 100644 --- a/gooddata-api-client/docs/DataSourceControllerApi.md +++ b/gooddata-api-client/docs/DataSourceControllerApi.md @@ -44,6 +44,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -380,6 +382,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourcePatch( attributes=JsonApiDataSourcePatchAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -488,6 +492,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", diff --git a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md index 87c9f87cb..b31c0b27f 100644 --- a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md @@ -103,6 +103,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDataSource( alternative_data_source_id="pg_local_docker-demo2", authentication_type="USERNAME_PASSWORD", + cache_retention=CacheRetention(), cache_strategy="ALWAYS", client_id="client1234", client_secret="client_secret_example", @@ -125,7 +126,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", diff --git a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md index 0592e0a5d..03204c83d 100644 --- a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md @@ -46,6 +46,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -540,6 +542,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourcePatch( attributes=JsonApiDataSourcePatchAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -648,6 +652,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", diff --git a/gooddata-api-client/docs/DateFilter.md b/gooddata-api-client/docs/DateFilter.md index 20b25cb52..8668f0838 100644 --- a/gooddata-api-client/docs/DateFilter.md +++ b/gooddata-api-client/docs/DateFilter.md @@ -6,6 +6,7 @@ Abstract filter definition type for dates. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] +**absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.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/DateTruncPartitionConfig.md b/gooddata-api-client/docs/DateTruncPartitionConfig.md index fdb8d84f9..5069f1cf5 100644 --- a/gooddata-api-client/docs/DateTruncPartitionConfig.md +++ b/gooddata-api-client/docs/DateTruncPartitionConfig.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **column** | **str** | Column to partition on. | **unit** | **str** | Date/time unit for partition granularity | +**type** | **str** | | defaults to "dateTrunc" **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/DeclarativeCalendar.md b/gooddata-api-client/docs/DeclarativeCalendar.md new file mode 100644 index 000000000..87450931a --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeCalendar.md @@ -0,0 +1,16 @@ +# DeclarativeCalendar + +A custom fiscal calendar definition. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**definition** | [**CalendarDefinition**](CalendarDefinition.md) | | +**enabled_granularities** | [**[CalendarGranularity]**](CalendarGranularity.md) | Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy. | +**name** | **str** | Calendar title. | +**description** | **str** | Calendar description. | [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/DeclarativeDataSource.md b/gooddata-api-client/docs/DeclarativeDataSource.md index 056a34b16..4f23fee45 100644 --- a/gooddata-api-client/docs/DeclarativeDataSource.md +++ b/gooddata-api-client/docs/DeclarativeDataSource.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **type** | **str** | Type of database. | **alternative_data_source_id** | **str, none_type** | Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source. | [optional] **authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] +**cache_retention** | [**CacheRetention**](CacheRetention.md) | | [optional] **cache_strategy** | **str** | Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached. | [optional] **client_id** | **str** | Id of client with permission to connect to the data source. | [optional] **client_secret** | **str** | The client secret to use to connect to the database providing the data for the data source. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeExportDefinition.md b/gooddata-api-client/docs/DeclarativeExportDefinition.md index f7a32553c..9b296a0ec 100644 --- a/gooddata-api-client/docs/DeclarativeExportDefinition.md +++ b/gooddata-api-client/docs/DeclarativeExportDefinition.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **description** | **str** | Export definition object description. | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**request_payload** | [**DeclarativeExportDefinitionRequestPayload**](DeclarativeExportDefinitionRequestPayload.md) | | [optional] +**request_payload** | [**ExportRequest**](ExportRequest.md) | | [optional] **tags** | **[str]** | A list of tags. | [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/DeclarativeExportDefinitionRequestPayload.md b/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md deleted file mode 100644 index 1ef446edb..000000000 --- a/gooddata-api-client/docs/DeclarativeExportDefinitionRequestPayload.md +++ /dev/null @@ -1,21 +0,0 @@ -# DeclarativeExportDefinitionRequestPayload - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] -**execution_result** | **str** | Execution result identifier. | [optional] -**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Metadata definition in free-form JSON format. | [optional] -**related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] -**settings** | [**Settings**](Settings.md) | | [optional] -**visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] -**visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] -**file_name** | **str** | File name to be used for retrieving the pdf document. | [optional] -**format** | **str** | Expected file format. | [optional] -**dashboard_id** | **str** | Dashboard identifier | [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/DeclarativeLdm.md b/gooddata-api-client/docs/DeclarativeLdm.md index 46676f00e..87d0a97d1 100644 --- a/gooddata-api-client/docs/DeclarativeLdm.md +++ b/gooddata-api-client/docs/DeclarativeLdm.md @@ -5,6 +5,7 @@ A logical data model (LDM) representation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**calendars** | [**{str: (DeclarativeCalendar,)}**](DeclarativeCalendar.md) | Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace. | [optional] **dataset_extensions** | [**[DeclarativeDatasetExtension]**](DeclarativeDatasetExtension.md) | An array containing extensions for datasets defined in parent workspaces. | [optional] **datasets** | [**[DeclarativeDataset]**](DeclarativeDataset.md) | An array containing datasets. | [optional] **date_instances** | [**[DeclarativeDateDataset]**](DeclarativeDateDataset.md) | An array containing date-related datasets. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannel.md b/gooddata-api-client/docs/DeclarativeNotificationChannel.md index 5193110f3..8c33f4ac1 100644 --- a/gooddata-api-client/docs/DeclarativeNotificationChannel.md +++ b/gooddata-api-client/docs/DeclarativeNotificationChannel.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **custom_dashboard_url** | **str** | Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} | [optional] **dashboard_link_visibility** | **str** | Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link | [optional] if omitted the server will use the default value of "INTERNAL_ONLY" **description** | **str** | Description of a notification channel. | [optional] -**destination** | [**DeclarativeNotificationChannelDestination**](DeclarativeNotificationChannelDestination.md) | | [optional] +**destination** | [**NotificationChannelDestination**](NotificationChannelDestination.md) | | [optional] **destination_type** | **str, none_type** | | [optional] [readonly] **in_platform_notification** | **str** | In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications | [optional] if omitted the server will use the default value of "DISABLED" **name** | **str** | Name of a notification channel. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md b/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md deleted file mode 100644 index 23bd60492..000000000 --- a/gooddata-api-client/docs/DeclarativeNotificationChannelDestination.md +++ /dev/null @@ -1,23 +0,0 @@ -# DeclarativeNotificationChannelDestination - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**from_email** | **str** | E-mail address to send notifications from. | [optional] if omitted the server will use the default value of no-reply@gooddata.com -**from_email_name** | **str** | An optional e-mail name to send notifications from. | [optional] if omitted the server will use the default value of "GoodData" -**host** | **str** | The SMTP server address. | [optional] -**password** | **str** | The SMTP server password. | [optional] -**port** | **int** | The SMTP server port. | [optional] -**username** | **str** | The SMTP server username. | [optional] -**has_secret_key** | **bool, none_type** | Flag indicating if webhook has a hmac secret key. | [optional] [readonly] -**has_token** | **bool, none_type** | Flag indicating if webhook has a token. | [optional] [readonly] -**secret_key** | **str, none_type** | Hmac secret key for the webhook signature. | [optional] -**token** | **str, none_type** | Bearer token for the webhook. | [optional] -**url** | **str** | The webhook URL. | [optional] -**type** | **str** | The destination type. | [optional] if omitted the server will use the default value of "WEBHOOK" -**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/DeclarativeParameter.md b/gooddata-api-client/docs/DeclarativeParameter.md index f249792be..5b6a886ee 100644 --- a/gooddata-api-client/docs/DeclarativeParameter.md +++ b/gooddata-api-client/docs/DeclarativeParameter.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**DeclarativeParameterContent**](DeclarativeParameterContent.md) | | +**content** | [**ParameterDefinition**](ParameterDefinition.md) | | **id** | **str** | Parameter ID. | **title** | **str** | Parameter title. | **created_at** | **str, none_type** | Time of the entity creation. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeWorkspace.md b/gooddata-api-client/docs/DeclarativeWorkspace.md index 91d84478c..2e798d843 100644 --- a/gooddata-api-client/docs/DeclarativeWorkspace.md +++ b/gooddata-api-client/docs/DeclarativeWorkspace.md @@ -9,18 +9,22 @@ Name | Type | Description | Notes **name** | **str** | Name of a workspace to view. | **automations** | [**[DeclarativeAutomation]**](DeclarativeAutomation.md) | | [optional] **cache_extra_limit** | **int** | Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces. | [optional] +**color_palettes** | [**[DeclarativeWorkspaceColorPalette]**](DeclarativeWorkspaceColorPalette.md) | A list of workspace color palettes. | [optional] **custom_application_settings** | [**[DeclarativeCustomApplicationSetting]**](DeclarativeCustomApplicationSetting.md) | A list of workspace custom settings. | [optional] **data_source** | [**WorkspaceDataSource**](WorkspaceDataSource.md) | | [optional] **description** | **str** | Description of the workspace | [optional] **early_access** | **str** | Early access defined on level Workspace | [optional] **early_access_values** | **[str]** | Early access defined on level Workspace | [optional] +**export_templates** | [**[DeclarativeWorkspaceExportTemplate]**](DeclarativeWorkspaceExportTemplate.md) | A list of workspace export templates. | [optional] **filter_views** | [**[DeclarativeFilterView]**](DeclarativeFilterView.md) | | [optional] **hierarchy_permissions** | [**[DeclarativeWorkspaceHierarchyPermission]**](DeclarativeWorkspaceHierarchyPermission.md) | | [optional] +**managed** | **bool** | Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled). | [optional] [readonly] **model** | [**DeclarativeWorkspaceModel**](DeclarativeWorkspaceModel.md) | | [optional] **parent** | [**WorkspaceIdentifier**](WorkspaceIdentifier.md) | | [optional] **permissions** | [**[DeclarativeSingleWorkspacePermission]**](DeclarativeSingleWorkspacePermission.md) | | [optional] **prefix** | **str** | Custom prefix of entity identifiers in workspace | [optional] **settings** | [**[DeclarativeSetting]**](DeclarativeSetting.md) | A list of workspace settings. | [optional] +**themes** | [**[DeclarativeWorkspaceTheme]**](DeclarativeWorkspaceTheme.md) | A list of workspace themes. | [optional] **user_data_filters** | [**[DeclarativeUserDataFilter]**](DeclarativeUserDataFilter.md) | A list of workspace user data filters. | [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/DeclarativeWorkspaceColorPalette.md b/gooddata-api-client/docs/DeclarativeWorkspaceColorPalette.md new file mode 100644 index 000000000..6d3a8753b --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeWorkspaceColorPalette.md @@ -0,0 +1,15 @@ +# DeclarativeWorkspaceColorPalette + +Workspace color palette and its properties. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonNode**](JsonNode.md) | | +**id** | **str** | | +**name** | **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] + +[[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/DeclarativeWorkspaceExportTemplate.md b/gooddata-api-client/docs/DeclarativeWorkspaceExportTemplate.md new file mode 100644 index 000000000..3556d5b57 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeWorkspaceExportTemplate.md @@ -0,0 +1,16 @@ +# DeclarativeWorkspaceExportTemplate + +A declarative form of a workspace export template. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Identifier of a workspace export template | +**name** | **str** | Name of a workspace export template. | +**dashboard_slides_template** | [**WorkspaceDashboardSlidesTemplate**](WorkspaceDashboardSlidesTemplate.md) | | [optional] +**widget_slides_template** | [**WorkspaceWidgetSlidesTemplate**](WorkspaceWidgetSlidesTemplate.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/DeclarativeWorkspaceTheme.md b/gooddata-api-client/docs/DeclarativeWorkspaceTheme.md new file mode 100644 index 000000000..de24f5014 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeWorkspaceTheme.md @@ -0,0 +1,15 @@ +# DeclarativeWorkspaceTheme + +Workspace theme and its properties. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonNode**](JsonNode.md) | | +**id** | **str** | | +**name** | **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] + +[[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/DuplicateKeyConfig.md b/gooddata-api-client/docs/DuplicateKeyConfig.md index d3c478203..153ab4cae 100644 --- a/gooddata-api-client/docs/DuplicateKeyConfig.md +++ b/gooddata-api-client/docs/DuplicateKeyConfig.md @@ -5,6 +5,7 @@ Duplicate key model — allows duplicate rows for the given key columns. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "duplicate" **columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/ElementsRequest.md b/gooddata-api-client/docs/ElementsRequest.md index 8d321bf1b..e27fa7257 100644 --- a/gooddata-api-client/docs/ElementsRequest.md +++ b/gooddata-api-client/docs/ElementsRequest.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **filter_by** | [**FilterBy**](FilterBy.md) | | [optional] **pattern_filter** | **str** | Return only items, whose ```label``` title case insensitively contains ```filter``` as substring. | [optional] **sort_order** | **str** | Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default | [optional] +**timezone** | **str** | Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used. | [optional] **validate_by** | [**[ValidateByItem]**](ValidateByItem.md) | Return only items that are computable on metric. | [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/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 7dc45ca34..8e2d895a4 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -29,6 +29,7 @@ Method | HTTP request | Description [**create_entity_memory_items**](EntitiesApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items [**create_entity_metrics**](EntitiesApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics [**create_entity_notification_channels**](EntitiesApi.md#create_entity_notification_channels) | **POST** /api/v1/entities/notificationChannels | Post Notification Channel entities +[**create_entity_org_memory_items**](EntitiesApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities [**create_entity_organization_settings**](EntitiesApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities [**create_entity_parameters**](EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters [**create_entity_themes**](EntitiesApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming @@ -37,9 +38,12 @@ Method | HTTP request | Description [**create_entity_user_settings**](EntitiesApi.md#create_entity_user_settings) | **POST** /api/v1/entities/users/{userId}/userSettings | Post new user settings for the user [**create_entity_users**](EntitiesApi.md#create_entity_users) | **POST** /api/v1/entities/users | Post User entities [**create_entity_visualization_objects**](EntitiesApi.md#create_entity_visualization_objects) | **POST** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Post Visualization Objects +[**create_entity_workspace_color_palettes**](EntitiesApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette [**create_entity_workspace_data_filter_settings**](EntitiesApi.md#create_entity_workspace_data_filter_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Post Settings for Workspace Data Filters [**create_entity_workspace_data_filters**](EntitiesApi.md#create_entity_workspace_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Post Workspace Data Filters +[**create_entity_workspace_export_templates**](EntitiesApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template [**create_entity_workspace_settings**](EntitiesApi.md#create_entity_workspace_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Post Settings for Workspaces +[**create_entity_workspace_themes**](EntitiesApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme [**create_entity_workspaces**](EntitiesApi.md#create_entity_workspaces) | **POST** /api/v1/entities/workspaces | Post Workspace entities [**delete_entity**](EntitiesApi.md#delete_entity) | **DELETE** /api/v1/entities/llmEndpoints/{id} | Delete LLM endpoint entity (Removed) [**delete_entity_agents**](EntitiesApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity @@ -66,6 +70,7 @@ Method | HTTP request | Description [**delete_entity_memory_items**](EntitiesApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item [**delete_entity_metrics**](EntitiesApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric [**delete_entity_notification_channels**](EntitiesApi.md#delete_entity_notification_channels) | **DELETE** /api/v1/entities/notificationChannels/{id} | Delete Notification Channel entity +[**delete_entity_org_memory_items**](EntitiesApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity [**delete_entity_organization_settings**](EntitiesApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization Setting entity [**delete_entity_parameters**](EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter [**delete_entity_themes**](EntitiesApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming @@ -74,9 +79,12 @@ Method | HTTP request | Description [**delete_entity_user_settings**](EntitiesApi.md#delete_entity_user_settings) | **DELETE** /api/v1/entities/users/{userId}/userSettings/{id} | Delete a setting for a user [**delete_entity_users**](EntitiesApi.md#delete_entity_users) | **DELETE** /api/v1/entities/users/{id} | Delete User entity [**delete_entity_visualization_objects**](EntitiesApi.md#delete_entity_visualization_objects) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Delete a Visualization Object +[**delete_entity_workspace_color_palettes**](EntitiesApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette [**delete_entity_workspace_data_filter_settings**](EntitiesApi.md#delete_entity_workspace_data_filter_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Delete a Settings for Workspace Data Filter [**delete_entity_workspace_data_filters**](EntitiesApi.md#delete_entity_workspace_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Delete a Workspace Data Filter +[**delete_entity_workspace_export_templates**](EntitiesApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template [**delete_entity_workspace_settings**](EntitiesApi.md#delete_entity_workspace_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Delete a Setting for Workspace +[**delete_entity_workspace_themes**](EntitiesApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme [**delete_entity_workspaces**](EntitiesApi.md#delete_entity_workspaces) | **DELETE** /api/v1/entities/workspaces/{id} | Delete Workspace entity [**get_all_automations_workspace_automations**](EntitiesApi.md#get_all_automations_workspace_automations) | **GET** /api/v1/entities/organization/workspaceAutomations | Get all Automations across all Workspaces [**get_all_entities**](EntitiesApi.md#get_all_entities) | **GET** /api/v1/entities/llmEndpoints | Get all LLM endpoint entities (Removed) @@ -102,6 +110,7 @@ Method | HTTP request | Description [**get_all_entities_facts**](EntitiesApi.md#get_all_entities_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts | Get all Facts [**get_all_entities_filter_contexts**](EntitiesApi.md#get_all_entities_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Get all Filter Context [**get_all_entities_filter_views**](EntitiesApi.md#get_all_entities_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews | Get all Filter views +[**get_all_entities_fiscal_calendars**](EntitiesApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars [**get_all_entities_identity_providers**](EntitiesApi.md#get_all_entities_identity_providers) | **GET** /api/v1/entities/identityProviders | Get all Identity Providers [**get_all_entities_ip_allowlist_policies**](EntitiesApi.md#get_all_entities_ip_allowlist_policies) | **GET** /api/v1/entities/ipAllowlistPolicies | Get all IpAllowlistPolicy entities [**get_all_entities_jwks**](EntitiesApi.md#get_all_entities_jwks) | **GET** /api/v1/entities/jwks | Get all Jwks @@ -112,6 +121,7 @@ Method | HTTP request | Description [**get_all_entities_metrics**](EntitiesApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics [**get_all_entities_notification_channel_identifiers**](EntitiesApi.md#get_all_entities_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers | Get all Notification Channel Identifier entities [**get_all_entities_notification_channels**](EntitiesApi.md#get_all_entities_notification_channels) | **GET** /api/v1/entities/notificationChannels | Get all Notification Channel entities +[**get_all_entities_org_memory_items**](EntitiesApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities [**get_all_entities_organization_settings**](EntitiesApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization Setting entities [**get_all_entities_parameters**](EntitiesApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters [**get_all_entities_themes**](EntitiesApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities @@ -121,9 +131,12 @@ Method | HTTP request | Description [**get_all_entities_user_settings**](EntitiesApi.md#get_all_entities_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings | List all settings for a user [**get_all_entities_users**](EntitiesApi.md#get_all_entities_users) | **GET** /api/v1/entities/users | Get User entities [**get_all_entities_visualization_objects**](EntitiesApi.md#get_all_entities_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects | Get all Visualization Objects +[**get_all_entities_workspace_color_palettes**](EntitiesApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes [**get_all_entities_workspace_data_filter_settings**](EntitiesApi.md#get_all_entities_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings | Get all Settings for Workspace Data Filters [**get_all_entities_workspace_data_filters**](EntitiesApi.md#get_all_entities_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters | Get all Workspace Data Filters +[**get_all_entities_workspace_export_templates**](EntitiesApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates [**get_all_entities_workspace_settings**](EntitiesApi.md#get_all_entities_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings | Get all Setting for Workspaces +[**get_all_entities_workspace_themes**](EntitiesApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes [**get_all_entities_workspaces**](EntitiesApi.md#get_all_entities_workspaces) | **GET** /api/v1/entities/workspaces | Get Workspace entities [**get_all_options**](EntitiesApi.md#get_all_options) | **GET** /api/v1/options | Links for all configuration options [**get_data_source_drivers**](EntitiesApi.md#get_data_source_drivers) | **GET** /api/v1/options/availableDrivers | Get all available data source drivers @@ -151,6 +164,7 @@ Method | HTTP request | Description [**get_entity_facts**](EntitiesApi.md#get_entity_facts) | **GET** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Get a Fact [**get_entity_filter_contexts**](EntitiesApi.md#get_entity_filter_contexts) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Get a Filter Context [**get_entity_filter_views**](EntitiesApi.md#get_entity_filter_views) | **GET** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Get Filter view +[**get_entity_fiscal_calendars**](EntitiesApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar [**get_entity_identity_providers**](EntitiesApi.md#get_entity_identity_providers) | **GET** /api/v1/entities/identityProviders/{id} | Get Identity Provider [**get_entity_ip_allowlist_policies**](EntitiesApi.md#get_entity_ip_allowlist_policies) | **GET** /api/v1/entities/ipAllowlistPolicies/{id} | Get IpAllowlistPolicy entity [**get_entity_jwks**](EntitiesApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk @@ -161,6 +175,7 @@ Method | HTTP request | Description [**get_entity_metrics**](EntitiesApi.md#get_entity_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Get a Metric [**get_entity_notification_channel_identifiers**](EntitiesApi.md#get_entity_notification_channel_identifiers) | **GET** /api/v1/entities/notificationChannelIdentifiers/{id} | Get Notification Channel Identifier entity [**get_entity_notification_channels**](EntitiesApi.md#get_entity_notification_channels) | **GET** /api/v1/entities/notificationChannels/{id} | Get Notification Channel entity +[**get_entity_org_memory_items**](EntitiesApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity [**get_entity_organization_settings**](EntitiesApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization Setting entity [**get_entity_organizations**](EntitiesApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations [**get_entity_parameters**](EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter @@ -171,9 +186,12 @@ Method | HTTP request | Description [**get_entity_user_settings**](EntitiesApi.md#get_entity_user_settings) | **GET** /api/v1/entities/users/{userId}/userSettings/{id} | Get a setting for a user [**get_entity_users**](EntitiesApi.md#get_entity_users) | **GET** /api/v1/entities/users/{id} | Get User entity [**get_entity_visualization_objects**](EntitiesApi.md#get_entity_visualization_objects) | **GET** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Get a Visualization Object +[**get_entity_workspace_color_palettes**](EntitiesApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette [**get_entity_workspace_data_filter_settings**](EntitiesApi.md#get_entity_workspace_data_filter_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Get a Setting for Workspace Data Filter [**get_entity_workspace_data_filters**](EntitiesApi.md#get_entity_workspace_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Get a Workspace Data Filter +[**get_entity_workspace_export_templates**](EntitiesApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template [**get_entity_workspace_settings**](EntitiesApi.md#get_entity_workspace_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Get a Setting for Workspace +[**get_entity_workspace_themes**](EntitiesApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme [**get_entity_workspaces**](EntitiesApi.md#get_entity_workspaces) | **GET** /api/v1/entities/workspaces/{id} | Get Workspace entity [**get_organization**](EntitiesApi.md#get_organization) | **GET** /api/v1/entities/organization | Get current organization info [**patch_entity**](EntitiesApi.md#patch_entity) | **PATCH** /api/v1/entities/llmEndpoints/{id} | Patch LLM endpoint entity (Removed) @@ -203,6 +221,7 @@ Method | HTTP request | Description [**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 [**patch_entity_notification_channels**](EntitiesApi.md#patch_entity_notification_channels) | **PATCH** /api/v1/entities/notificationChannels/{id} | Patch Notification Channel entity +[**patch_entity_org_memory_items**](EntitiesApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity [**patch_entity_organization_settings**](EntitiesApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization Setting entity [**patch_entity_organizations**](EntitiesApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization [**patch_entity_parameters**](EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter @@ -211,9 +230,12 @@ Method | HTTP request | Description [**patch_entity_user_groups**](EntitiesApi.md#patch_entity_user_groups) | **PATCH** /api/v1/entities/userGroups/{id} | Patch UserGroup entity [**patch_entity_users**](EntitiesApi.md#patch_entity_users) | **PATCH** /api/v1/entities/users/{id} | Patch User entity [**patch_entity_visualization_objects**](EntitiesApi.md#patch_entity_visualization_objects) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Patch a Visualization Object +[**patch_entity_workspace_color_palettes**](EntitiesApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette [**patch_entity_workspace_data_filter_settings**](EntitiesApi.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**](EntitiesApi.md#patch_entity_workspace_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Patch a Workspace Data Filter +[**patch_entity_workspace_export_templates**](EntitiesApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template [**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) @@ -263,6 +285,7 @@ Method | HTTP request | Description [**update_entity_memory_items**](EntitiesApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item [**update_entity_metrics**](EntitiesApi.md#update_entity_metrics) | **PUT** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Put a Metric [**update_entity_notification_channels**](EntitiesApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity +[**update_entity_org_memory_items**](EntitiesApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity [**update_entity_organization_settings**](EntitiesApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization Setting entity [**update_entity_organizations**](EntitiesApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization [**update_entity_parameters**](EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter @@ -272,9 +295,12 @@ Method | HTTP request | Description [**update_entity_user_settings**](EntitiesApi.md#update_entity_user_settings) | **PUT** /api/v1/entities/users/{userId}/userSettings/{id} | Put new user settings for the user [**update_entity_users**](EntitiesApi.md#update_entity_users) | **PUT** /api/v1/entities/users/{id} | Put User entity [**update_entity_visualization_objects**](EntitiesApi.md#update_entity_visualization_objects) | **PUT** /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId} | Put a Visualization Object +[**update_entity_workspace_color_palettes**](EntitiesApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette [**update_entity_workspace_data_filter_settings**](EntitiesApi.md#update_entity_workspace_data_filter_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId} | Put a Settings for Workspace Data Filter [**update_entity_workspace_data_filters**](EntitiesApi.md#update_entity_workspace_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId} | Put a Workspace Data Filter +[**update_entity_workspace_export_templates**](EntitiesApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template [**update_entity_workspace_settings**](EntitiesApi.md#update_entity_workspace_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId} | Put a Setting for a Workspace +[**update_entity_workspace_themes**](EntitiesApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme [**update_entity_workspaces**](EntitiesApi.md#update_entity_workspaces) | **PUT** /api/v1/entities/workspaces/{id} | Put Workspace entity @@ -781,15 +807,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -804,11 +822,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -817,13 +831,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -853,6 +868,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -920,20 +936,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -954,6 +963,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -981,6 +991,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -1012,6 +1046,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -1025,6 +1062,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -1641,6 +1679,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -2927,6 +2967,102 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument create_entity_org_memory_items(json_api_org_memory_item_in_document) + +Post organization Memory Item entities + +Organization-scoped AI memory item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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) + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -3662,6 +3798,96 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + +Post Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +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 | + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPaletteInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -3877,10 +4103,10 @@ 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) -# **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) +# **create_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) -Post Settings for Workspaces +Post Workspace Export Template ### Example @@ -3889,8 +4115,8 @@ Post Settings for Workspaces import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument 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. @@ -3904,32 +4130,188 @@ 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 | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", + json_api_workspace_export_template_post_optional_id_document = JsonApiWorkspaceExportTemplatePostOptionalIdDocument( + data=JsonApiWorkspaceExportTemplatePostOptionalId( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), ), id="id1", - type="workspaceSetting", + type="workspaceExportTemplate", ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | + ) # JsonApiWorkspaceExportTemplatePostOptionalIdDocument | meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Settings for Workspaces + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_export_template_post_optional_id_document** | [**JsonApiWorkspaceExportTemplatePostOptionalIdDocument**](JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + +Post Settings for Workspaces + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +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 | + json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( + data=JsonApiWorkspaceSettingPostOptionalId( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", + ), + ) # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Settings for Workspaces + api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Settings for Workspaces api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -3959,6 +4341,96 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + +Post Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +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 | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -5659,6 +6131,69 @@ with gooddata_api_client.ApiClient() as api_client: ``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_org_memory_items** +> delete_entity_org_memory_items(id) + +Delete an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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 = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + + # example passing only required values which don't have defaults set + try: + # Delete an organization Memory Item entity + api_instance.delete_entity_org_memory_items(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_org_memory_items: %s\n" % e) +``` + + ### Parameters Name | Type | Description | Notes @@ -6203,10 +6738,10 @@ 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) -# **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) +# **delete_entity_workspace_color_palettes** +> delete_entity_workspace_color_palettes(workspace_id, object_id) -Delete a Settings for Workspace Data Filter +Delete a Workspace Color Palette ### Example @@ -6232,10 +6767,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) + # Delete a Workspace Color Palette + api_instance.delete_entity_workspace_color_palettes(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_color_palettes: %s\n" % e) ``` @@ -6268,10 +6803,10 @@ 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) -# **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) +# **delete_entity_workspace_data_filter_settings** +> delete_entity_workspace_data_filter_settings(workspace_id, object_id) -Delete a Workspace Data Filter +Delete a Settings for Workspace Data Filter ### Example @@ -6297,10 +6832,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) + # Delete a Settings for Workspace Data Filter + api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) ``` @@ -6333,10 +6868,10 @@ 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) -# **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) +# **delete_entity_workspace_data_filters** +> delete_entity_workspace_data_filters(workspace_id, object_id) -Delete a Setting for Workspace +Delete a Workspace Data Filter ### Example @@ -6362,10 +6897,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) + # Delete a Workspace Data Filter + api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) ``` @@ -6398,12 +6933,10 @@ 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) -# **delete_entity_workspaces** -> delete_entity_workspaces(id) - -Delete Workspace entity +# **delete_entity_workspace_export_templates** +> delete_entity_workspace_export_templates(workspace_id, object_id) -Space of the shared interest +Delete a Workspace Export Template ### Example @@ -6424,12 +6957,209 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set try: - # Delete Workspace entity - api_instance.delete_entity_workspaces(id) + # Delete a Workspace Export Template + api_instance.delete_entity_workspace_export_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_workspace_settings** +> delete_entity_workspace_settings(workspace_id, object_id) + +Delete a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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 = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Setting for Workspace + api_instance.delete_entity_workspace_settings(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_workspace_themes** +> delete_entity_workspace_themes(workspace_id, object_id) + +Delete a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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 = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Theme + api_instance.delete_entity_workspace_themes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[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) + +# **delete_entity_workspaces** +> delete_entity_workspaces(id) + +Delete Workspace entity + +Space of the shared interest + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_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 = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + + # example passing only required values which don't have defaults set + try: + # Delete Workspace entity + api_instance.delete_entity_workspaces(id) except gooddata_api_client.ApiException as e: print("Exception when calling EntitiesApi->delete_entity_workspaces: %s\n" % e) ``` @@ -8564,10 +9294,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +# **get_all_entities_fiscal_calendars** +> JsonApiFiscalCalendarOutList get_all_entities_fiscal_calendars(workspace_id) -Get all Identity Providers +Get all Fiscal Calendars ### Example @@ -8576,7 +9306,7 @@ Get all Identity Providers import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList 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. @@ -8589,24 +9319,35 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) + # example passing only required values which don't have defaults set + try: + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_fiscal_calendars: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all Identity Providers - api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_fiscal_calendars: %s\n" % e) ``` @@ -8614,15 +9355,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) +[**JsonApiFiscalCalendarOutList**](JsonApiFiscalCalendarOutList.md) ### Authorization @@ -8642,10 +9386,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_ip_allowlist_policies** -> JsonApiIpAllowlistPolicyOutList get_all_entities_ip_allowlist_policies() +# **get_all_entities_identity_providers** +> JsonApiIdentityProviderOutList get_all_entities_identity_providers() -Get all IpAllowlistPolicy entities +Get all Identity Providers ### Example @@ -8654,7 +9398,7 @@ Get all IpAllowlistPolicy entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_ip_allowlist_policy_out_list import JsonApiIpAllowlistPolicyOutList +from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList 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. @@ -8667,10 +9411,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "users,userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 sort = [ @@ -8683,11 +9424,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all IpAllowlistPolicy entities - api_response = api_instance.get_all_entities_ip_allowlist_policies(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Identity Providers + api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_ip_allowlist_policies: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_identity_providers: %s\n" % e) ``` @@ -8696,7 +9437,6 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -8704,7 +9444,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiIpAllowlistPolicyOutList**](JsonApiIpAllowlistPolicyOutList.md) +[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) ### Authorization @@ -8724,12 +9464,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() - -Get all Jwks +# **get_all_entities_ip_allowlist_policies** +> JsonApiIpAllowlistPolicyOutList get_all_entities_ip_allowlist_policies() -Returns all JSON web keys - used to verify JSON web tokens (Jwts) +Get all IpAllowlistPolicy entities ### Example @@ -8738,7 +9476,7 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.model.json_api_ip_allowlist_policy_out_list import JsonApiIpAllowlistPolicyOutList 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. @@ -8751,7 +9489,10 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "users,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 sort = [ @@ -8764,11 +9505,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Jwks - api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all IpAllowlistPolicy entities + api_response = api_instance.get_all_entities_ip_allowlist_policies(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_ip_allowlist_policies: %s\n" % e) ``` @@ -8777,6 +9518,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -8784,7 +9526,87 @@ Name | Type | Description | Notes ### Return type -[**JsonApiJwkOutList**](JsonApiJwkOutList.md) +[**JsonApiIpAllowlistPolicyOutList**](JsonApiIpAllowlistPolicyOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_all_entities_jwks** +> JsonApiJwkOutList get_all_entities_jwks() + +Get all Jwks + +Returns all JSON web keys - used to verify JSON web tokens (Jwts) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +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) + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Jwks + api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_jwks: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiJwkOutList**](JsonApiJwkOutList.md) ### Authorization @@ -9414,6 +10236,88 @@ 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) + +# **get_all_entities_org_memory_items** +> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() + +Get all organization Memory Item entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +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) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all organization Memory Item entities + api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -10202,10 +11106,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) +# **get_all_entities_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutList get_all_entities_workspace_color_palettes(workspace_id) -Get all Settings for Workspace Data Filters +Get all Workspace Color Palettes ### Example @@ -10214,7 +11118,7 @@ Get all Settings for Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList 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. @@ -10229,10 +11133,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 sort = [ @@ -10245,20 +11146,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) ``` @@ -10269,7 +11170,6 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -10278,7 +11178,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) +[**JsonApiWorkspaceColorPaletteOutList**](JsonApiWorkspaceColorPaletteOutList.md) ### Authorization @@ -10298,10 +11198,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) +# **get_all_entities_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) -Get all Workspace Data Filters +Get all Settings for Workspace Data Filters ### Example @@ -10310,7 +11210,7 @@ Get all Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList 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. @@ -10325,9 +11225,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "filterSettings", + "workspaceDataFilter", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 @@ -10341,20 +11241,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) ``` @@ -10374,7 +11274,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) +[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) ### Authorization @@ -10394,10 +11294,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) +# **get_all_entities_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) -Get all Setting for Workspaces +Get all Workspace Data Filters ### Example @@ -10406,7 +11306,7 @@ Get all Setting for Workspaces import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList 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. @@ -10421,7 +11321,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 sort = [ @@ -10434,20 +11337,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) ``` @@ -10458,6 +11361,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -10466,7 +11370,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) +[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) ### Authorization @@ -10486,12 +11390,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspaces** -> JsonApiWorkspaceOutList get_all_entities_workspaces() - -Get Workspace entities +# **get_all_entities_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutList get_all_entities_workspace_export_templates(workspace_id) -Space of the shared interest +Get all Workspace Export Templates ### Example @@ -10500,7 +11402,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList 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. @@ -10513,27 +11415,35 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) + # example passing only required values which don't have defaults set + try: + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get Workspace entities - api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) ``` @@ -10541,16 +11451,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceOutList**](JsonApiWorkspaceOutList.md) +[**JsonApiWorkspaceExportTemplateOutList**](JsonApiWorkspaceExportTemplateOutList.md) ### Authorization @@ -10570,12 +11482,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_options** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() - -Links for all configuration options +# **get_all_entities_workspace_settings** +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) -Retrieves links for all options for different configurations. +Get all Setting for Workspaces ### Example @@ -10584,6 +11494,7 @@ Retrieves links for all options for different configurations. import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList 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. @@ -10596,23 +11507,54 @@ configuration = gooddata_api_client.Configuration( 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 | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) - # example, this endpoint has no required or optional parameters + # example passing only required values which don't have defaults set try: - # Links for all configuration options - api_response = api_instance.get_all_options() + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_options: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) ### Authorization @@ -10621,23 +11563,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Links for all configuration options. | - | +**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) -# **get_data_source_drivers** -> {str: (str,)} get_data_source_drivers() - -Get all available data source drivers +# **get_all_entities_workspace_themes** +> JsonApiWorkspaceThemeOutList get_all_entities_workspace_themes(workspace_id) -Retrieves a list of all supported data sources along with information about the used drivers. +Get all Workspace Themes ### Example @@ -10646,6 +11586,7 @@ Retrieves a list of all supported data sources along with information about the import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList 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. @@ -10658,23 +11599,54 @@ configuration = gooddata_api_client.Configuration( 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 | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) - # example, this endpoint has no required or optional parameters + # example passing only required values which don't have defaults set try: - # Get all available data source drivers - api_response = api_instance.get_data_source_drivers() + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_data_source_drivers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -**{str: (str,)}** +[**JsonApiWorkspaceThemeOutList**](JsonApiWorkspaceThemeOutList.md) ### Authorization @@ -10683,23 +11655,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | A list of all available data source drivers. | - | +**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) -# **get_entity** -> get_entity(id) +# **get_all_entities_workspaces** +> JsonApiWorkspaceOutList get_all_entities_workspaces() -Get LLM endpoint entity (Removed) +Get Workspace entities -Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. +Space of the shared interest ### Example @@ -10708,6 +11680,7 @@ Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 4 import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList 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. @@ -10720,14 +11693,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "id_example" # str | + filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "parent", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set + # and optional values try: - # Get LLM endpoint entity (Removed) - api_instance.get_entity(id) + # Get Workspace entities + api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspaces: %s\n" % e) ``` @@ -10735,11 +11721,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiWorkspaceOutList**](JsonApiWorkspaceOutList.md) ### Authorization @@ -10748,21 +11739,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**410** | Gone | - | +**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) -# **get_entity_agents** -> JsonApiAgentOutDocument get_entity_agents(id) +# **get_all_options** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() -Get Agent entity +Links for all configuration options + +Retrieves links for all options for different configurations. ### Example @@ -10771,7 +11764,6 @@ Get Agent entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument 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. @@ -10784,42 +11776,23 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - - # example passing only required values which don't have defaults set - try: - # Get Agent entity - api_response = api_instance.get_entity_agents(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Get Agent entity - api_response = api_instance.get_entity_agents(id, filter=filter, include=include) + # Links for all configuration options + api_response = api_instance.get_all_options() pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_options: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] +This endpoint does not need any parameter. ### Return type -[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.md) +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** ### Authorization @@ -10828,21 +11801,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**200** | Links for all configuration options. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_aggregated_facts** -> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) +# **get_data_source_drivers** +> {str: (str,)} get_data_source_drivers() -Get an Aggregated Fact +Get all available data source drivers + +Retrieves a list of all supported data sources along with information about the used drivers. ### Example @@ -10851,7 +11826,6 @@ Get an Aggregated Fact import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument 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. @@ -10864,50 +11838,23 @@ configuration = gooddata_api_client.Configuration( 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 | - object_id = "objectId_example" # str | - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact,sourceAttribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get an Aggregated Fact - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Get an Aggregated Fact - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all available data source drivers + api_response = api_instance.get_data_source_drivers() pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_data_source_drivers: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] +This endpoint does not need any parameter. ### Return type -[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) +**{str: (str,)}** ### Authorization @@ -10916,21 +11863,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**200** | A list of all available data source drivers. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) +# **get_entity** +> get_entity(id) -Get a Dashboard +Get LLM endpoint entity (Removed) + +Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. ### Example @@ -10939,7 +11888,6 @@ Get a Dashboard import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument 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. @@ -10952,16 +11900,248 @@ configuration = gooddata_api_client.Configuration( 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 | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=permissions,origin,accessInfo,all", - ] # [str] | Include Meta objects. (optional) + id = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Get LLM endpoint entity (Removed) + api_instance.get_entity(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**410** | Gone | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_agents** +> JsonApiAgentOutDocument get_entity_agents(id) + +Get Agent entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Agent entity + api_response = api_instance.get_entity_agents(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Agent entity + api_response = api_instance.get_entity_agents(id, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_aggregated_facts** +> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) + +Get an Aggregated Fact + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +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 | + object_id = "objectId_example" # str | + filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,sourceFact,sourceAttribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an Aggregated Fact + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an Aggregated Fact + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) + +Get a Dashboard + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +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 | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,accessInfo,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: @@ -12665,10 +13845,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_identity_providers** -> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) +# **get_entity_fiscal_calendars** +> JsonApiFiscalCalendarOutDocument get_entity_fiscal_calendars(workspace_id, object_id) -Get Identity Provider +Get a Fiscal Calendar ### Example @@ -12677,7 +13857,7 @@ Get Identity Provider import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument 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. @@ -12690,21 +13870,101 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + 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: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Identity Provider + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFiscalCalendarOutDocument**](JsonApiFiscalCalendarOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_identity_providers** +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) + +Get Identity Provider + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Identity Provider api_response = api_instance.get_entity_identity_providers(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -13471,6 +14731,86 @@ 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) + +# **get_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) + +Get an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -14299,10 +15639,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) +# **get_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument get_entity_workspace_color_palettes(workspace_id, object_id) -Get a Setting for Workspace Data Filter +Get a Workspace Color Palette ### Example @@ -14311,7 +15651,7 @@ Get a Setting for Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument 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. @@ -14326,10 +15666,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "workspaceDataFilter", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=origin,all", @@ -14337,20 +15674,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) ``` @@ -14361,13 +15698,12 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) ### Authorization @@ -14387,10 +15723,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) +# **get_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) -Get a Workspace Data Filter +Get a Setting for Workspace Data Filter ### Example @@ -14399,7 +15735,7 @@ Get a Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument 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. @@ -14414,9 +15750,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "filterSettings", + "workspaceDataFilter", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -14425,20 +15761,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) ``` @@ -14455,7 +15791,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) ### Authorization @@ -14475,10 +15811,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) +# **get_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) -Get a Setting for Workspace +Get a Workspace Data Filter ### Example @@ -14487,7 +15823,7 @@ Get a Setting for Workspace import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument 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. @@ -14502,7 +15838,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=origin,all", @@ -14510,20 +15849,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) ``` @@ -14534,12 +15873,13 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) ### Authorization @@ -14559,12 +15899,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspaces** -> JsonApiWorkspaceOutDocument get_entity_workspaces(id) - -Get Workspace entity +# **get_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument get_entity_workspace_export_templates(workspace_id, object_id) -Space of the shared interest +Get a Workspace Export Template ### Example @@ -14573,7 +15911,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument 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. @@ -14586,31 +15924,30 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id) + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_workspace_export_templates: %s\n" % e) ``` @@ -14618,14 +15955,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) ### Authorization @@ -14645,12 +15983,266 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_organization** -> get_organization() - -Get current organization info +# **get_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) -Gets a basic information about organization. +Get a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +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 | + object_id = "objectId_example" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument get_entity_workspace_themes(workspace_id, object_id) + +Get a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +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 | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspaces** +> JsonApiWorkspaceOutDocument get_entity_workspaces(id) + +Get Workspace entity + +Space of the shared interest + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "parent", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Workspace entity + api_response = api_instance.get_entity_workspaces(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Workspace entity + api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_organization** +> get_organization() + +Get current organization info + +Gets a basic information about organization. ### Example @@ -15252,15 +16844,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -15275,11 +16859,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -15288,13 +16868,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -15324,6 +16905,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -15391,20 +16973,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -15425,6 +17000,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -15452,8 +17028,32 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - file_name="result", - format="CSV", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], + file_name="result", + format="CSV", metadata=JsonNode(), related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", settings=Settings( @@ -15483,6 +17083,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -15496,6 +17099,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -16161,6 +17765,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourcePatch( attributes=JsonApiDataSourcePatchAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -17697,6 +19303,104 @@ 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) + +# **patch_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + +Patch an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( + data=JsonApiOrgMemoryItemPatch( + attributes=JsonApiOrgMemoryItemPatchAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -18493,6 +20197,96 @@ 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) + +# **patch_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) + +Patch a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument +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 | + object_id = "objectId_example" # str | + json_api_workspace_color_palette_patch_document = JsonApiWorkspaceColorPalettePatchDocument( + data=JsonApiWorkspaceColorPalettePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPalettePatchDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_color_palette_patch_document** | [**JsonApiWorkspaceColorPalettePatchDocument**](JsonApiWorkspaceColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -18649,30 +20443,277 @@ with gooddata_api_client.ApiClient() as api_client: ]), ), ), - type="workspaceDataFilter", + type="workspaceDataFilter", + ), + ) # JsonApiWorkspaceDataFilterPatchDocument | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Data Filter + api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **patch_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) + +Patch a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 | + object_id = "objectId_example" # str | + json_api_workspace_export_template_patch_document = JsonApiWorkspaceExportTemplatePatchDocument( + data=JsonApiWorkspaceExportTemplatePatch( + attributes=JsonApiWorkspaceExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplatePatchDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_patch_document** | [**JsonApiWorkspaceExportTemplatePatchDocument**](JsonApiWorkspaceExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **patch_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) + +Patch a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +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 | + object_id = "objectId_example" # str | + json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( + data=JsonApiWorkspaceSettingPatch( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", ), - ) # JsonApiWorkspaceDataFilterPatchDocument | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiWorkspaceSettingPatchDocument | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document) + # Patch a Setting for Workspace + api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Workspace Data Filter - api_response = api_instance.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, filter=filter, include=include) + # Patch a Setting for Workspace + api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) ``` @@ -18682,13 +20723,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_workspace_data_filter_patch_document** | [**JsonApiWorkspaceDataFilterPatchDocument**](JsonApiWorkspaceDataFilterPatchDocument.md)| | + **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) ### Authorization @@ -18708,10 +20748,10 @@ 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) -# **patch_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) +# **patch_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) -Patch a Setting for Workspace +Patch a Workspace Theme ### Example @@ -18720,8 +20760,8 @@ Patch a Setting for Workspace import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument -from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument 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. @@ -18736,34 +20776,34 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( - data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( + json_api_workspace_theme_patch_document = JsonApiWorkspaceThemePatchDocument( + data=JsonApiWorkspaceThemePatch( + attributes=JsonApiColorPalettePatchAttributes( content={}, - type="TIMEZONE", + name="name_example", ), id="id1", - type="workspaceSetting", + type="workspaceTheme", ), - ) # JsonApiWorkspaceSettingPatchDocument | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiWorkspaceThemePatchDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document) + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_workspace_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Setting for Workspace - api_response = api_instance.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, filter=filter) + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_workspace_themes: %s\n" % e) ``` @@ -18773,12 +20813,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_workspace_setting_patch_document** | [**JsonApiWorkspaceSettingPatchDocument**](JsonApiWorkspaceSettingPatchDocument.md)| | + **json_api_workspace_theme_patch_document** | [**JsonApiWorkspaceThemePatchDocument**](JsonApiWorkspaceThemePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) ### Authorization @@ -21623,15 +23663,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -21646,11 +23678,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -21659,13 +23687,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -21695,6 +23724,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -21762,20 +23792,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -21796,6 +23819,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -21823,6 +23847,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -21854,6 +23902,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -21867,6 +23918,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -22623,6 +24675,8 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiDataSourceIn( attributes=JsonApiDataSourceInAttributes( alternative_data_source_id="pg_local_docker-demo2", + authentication_type="USERNAME_PASSWORD", + cache_retention=JsonApiDataSourceInAttributesCacheRetention(None), cache_strategy="ALWAYS", client_id="client_id_example", client_secret="client_secret_example", @@ -23979,6 +26033,104 @@ 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) + +# **update_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + +Put an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -24729,16 +26881,115 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.update_entity_users(id, json_api_user_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put User entity + api_response = api_instance.update_entity_users(id, json_api_user_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiUserOutDocument**](JsonApiUserOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **update_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + +Put a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +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 | + object_id = "objectId_example" # str | + json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( + data=JsonApiVisualizationObjectIn( + attributes=JsonApiVisualizationObjectInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_hidden=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="visualizationObject", + ), + ) # JsonApiVisualizationObjectInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Visualization Object + api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put User entity - api_response = api_instance.update_entity_users(id, json_api_user_in_document, filter=filter, include=include) + # Put a Visualization Object + api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_users: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) ``` @@ -24746,14 +26997,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiUserOutDocument**](JsonApiUserOutDocument.md) +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) ### Authorization @@ -24773,10 +27025,10 @@ 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) -# **update_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) +# **update_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) -Put a Visualization Object +Put a Workspace Color Palette ### Example @@ -24785,8 +27037,8 @@ Put a Visualization Object import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument 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. @@ -24801,43 +27053,34 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_visualization_object_in_document = JsonApiVisualizationObjectInDocument( - data=JsonApiVisualizationObjectIn( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", + name="name_example", ), id="id1", - type="visualizationObject", + type="workspaceColorPalette", ), - ) # JsonApiVisualizationObjectInDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiWorkspaceColorPaletteInDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document) + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Visualization Object - api_response = api_instance.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, filter=filter, include=include) + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_workspace_color_palettes: %s\n" % e) ``` @@ -24847,13 +27090,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_visualization_object_in_document** | [**JsonApiVisualizationObjectInDocument**](JsonApiVisualizationObjectInDocument.md)| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) ### Authorization @@ -25072,6 +27314,162 @@ 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) + +# **update_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) + +Put a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +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 | + object_id = "objectId_example" # str | + json_api_workspace_export_template_in_document = JsonApiWorkspaceExportTemplateInDocument( + data=JsonApiWorkspaceExportTemplateIn( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplateInDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_in_document** | [**JsonApiWorkspaceExportTemplateInDocument**](JsonApiWorkspaceExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -25162,6 +27560,96 @@ 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) + +# **update_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) + +Put a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +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 | + object_id = "objectId_example" # str | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/ExecutionSettings.md b/gooddata-api-client/docs/ExecutionSettings.md index e31c1f582..1e1925092 100644 --- a/gooddata-api-client/docs/ExecutionSettings.md +++ b/gooddata-api-client/docs/ExecutionSettings.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_sampling_percentage** | **float** | Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views. | [optional] **timestamp** | **datetime** | Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used. | [optional] +**timezone** | **str** | Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[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/ExportRequest.md b/gooddata-api-client/docs/ExportRequest.md index 3e7569b35..1dc32c6ee 100644 --- a/gooddata-api-client/docs/ExportRequest.md +++ b/gooddata-api-client/docs/ExportRequest.md @@ -6,12 +6,16 @@ JSON content to be used as export request payload for /export/tabular and /expor Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**executions** | [**[TabularExportExecution]**](TabularExportExecution.md) | Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride. | [optional] **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] **visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] +**visualization_object_custom_parameters** | [**[ParameterValue]**](ParameterValue.md) | Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization. | [optional] **dashboard_id** | **str** | Dashboard identifier | [optional] **file_name** | **str** | Filename of downloaded file without extension. | [optional] **format** | **str** | Expected file format. | [optional] diff --git a/gooddata-api-client/docs/ExportTemplatesApi.md b/gooddata-api-client/docs/ExportTemplatesApi.md index f673debf1..f2342781f 100644 --- a/gooddata-api-client/docs/ExportTemplatesApi.md +++ b/gooddata-api-client/docs/ExportTemplatesApi.md @@ -5,11 +5,17 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_entity_export_templates**](ExportTemplatesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities +[**create_entity_workspace_export_templates**](ExportTemplatesApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template [**delete_entity_export_templates**](ExportTemplatesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity +[**delete_entity_workspace_export_templates**](ExportTemplatesApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template [**get_all_entities_export_templates**](ExportTemplatesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities +[**get_all_entities_workspace_export_templates**](ExportTemplatesApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates [**get_entity_export_templates**](ExportTemplatesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity +[**get_entity_workspace_export_templates**](ExportTemplatesApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template [**patch_entity_export_templates**](ExportTemplatesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity +[**patch_entity_workspace_export_templates**](ExportTemplatesApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template [**update_entity_export_templates**](ExportTemplatesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity +[**update_entity_workspace_export_templates**](ExportTemplatesApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template # **create_entity_export_templates** @@ -145,6 +151,162 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **create_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) + +Post Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 = export_templates_api.ExportTemplatesApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_export_template_post_optional_id_document = JsonApiWorkspaceExportTemplatePostOptionalIdDocument( + data=JsonApiWorkspaceExportTemplatePostOptionalId( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplatePostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->create_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->create_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_export_template_post_optional_id_document** | [**JsonApiWorkspaceExportTemplatePostOptionalIdDocument**](JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -216,10 +378,405 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +# **delete_entity_workspace_export_templates** +> delete_entity_workspace_export_templates(workspace_id, object_id) + +Delete a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_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 = export_templates_api.ExportTemplatesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Export Template + api_instance.delete_entity_workspace_export_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->delete_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_export_templates** +> JsonApiExportTemplateOutList get_all_entities_export_templates() + +GET all Export Template entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +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 = export_templates_api.ExportTemplatesApi(api_client) + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_all_entities_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_all_entities_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutList get_all_entities_workspace_export_templates(workspace_id) + +Get all Workspace Export Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +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 = export_templates_api.ExportTemplatesApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_all_entities_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_all_entities_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutList**](JsonApiWorkspaceExportTemplateOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_export_templates** +> JsonApiExportTemplateOutDocument get_entity_export_templates(id) + +GET Export Template entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +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 = export_templates_api.ExportTemplatesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument get_entity_workspace_export_templates(workspace_id, object_id) + +Get a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 = export_templates_api.ExportTemplatesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->get_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **patch_entity_export_templates** +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) -GET all Export Template entities +Patch Export Template entity ### Example @@ -228,7 +785,8 @@ GET all Export Template entities import time import gooddata_api_client from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument 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. @@ -241,24 +799,101 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = export_templates_api.ExportTemplatesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=JsonApiExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="exportTemplate", + ), + ) # JsonApiExportTemplatePatchDocument | filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # GET all Export Template entities - api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Patch Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->get_all_entities_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) ``` @@ -266,15 +901,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) ### Authorization @@ -282,7 +915,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -294,10 +927,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_export_templates** -> JsonApiExportTemplateOutDocument get_entity_export_templates(id) +# **patch_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) -GET Export Template entity +Patch a Workspace Export Template ### Example @@ -306,7 +939,8 @@ GET Export Template entity import time import gooddata_api_client from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument 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. @@ -319,25 +953,102 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_export_template_patch_document = JsonApiWorkspaceExportTemplatePatchDocument( + data=JsonApiWorkspaceExportTemplatePatch( + attributes=JsonApiWorkspaceExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplatePatchDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id) + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->patch_entity_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id, filter=filter) + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->get_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->patch_entity_workspace_export_templates: %s\n" % e) ``` @@ -345,12 +1056,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_patch_document** | [**JsonApiWorkspaceExportTemplatePatchDocument**](JsonApiWorkspaceExportTemplatePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) ### Authorization @@ -358,7 +1071,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json, application/vnd.gooddata.api+json - **Accept**: application/json, application/vnd.gooddata.api+json @@ -370,10 +1083,10 @@ 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) -# **patch_entity_export_templates** -> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) +# **update_entity_export_templates** +> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) -Patch Export Template entity +PUT Export Template entity ### Example @@ -382,8 +1095,8 @@ Patch Export Template entity import time import gooddata_api_client from gooddata_api_client.api import export_templates_api +from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument 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. @@ -397,9 +1110,9 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = export_templates_api.ExportTemplatesApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( - data=JsonApiExportTemplatePatch( - attributes=JsonApiExportTemplatePatchAttributes( + json_api_export_template_in_document = JsonApiExportTemplateInDocument( + data=JsonApiExportTemplateIn( + attributes=JsonApiExportTemplateInAttributes( dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( applied_on=["PDF","PPTX"], content_slide=ContentSlideTemplate( @@ -472,25 +1185,25 @@ with gooddata_api_client.ApiClient() as api_client: id="id1", type="exportTemplate", ), - ) # JsonApiExportTemplatePatchDocument | + ) # JsonApiExportTemplateInDocument | filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + # PUT Export Template entity + api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->patch_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) ``` @@ -499,7 +1212,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type @@ -524,10 +1237,10 @@ 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) -# **update_entity_export_templates** -> JsonApiExportTemplateOutDocument update_entity_export_templates(id, json_api_export_template_in_document) +# **update_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) -PUT Export Template entity +Put a Workspace Export Template ### Example @@ -536,8 +1249,8 @@ PUT Export Template entity import time import gooddata_api_client from gooddata_api_client.api import export_templates_api -from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument 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. @@ -550,11 +1263,12 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = export_templates_api.ExportTemplatesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_export_template_in_document = JsonApiExportTemplateInDocument( - data=JsonApiExportTemplateIn( - attributes=JsonApiExportTemplateInAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_export_template_in_document = JsonApiWorkspaceExportTemplateInDocument( + data=JsonApiWorkspaceExportTemplateIn( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( applied_on=["PDF","PPTX"], content_slide=ContentSlideTemplate( description_field="{{dashboardFilters}}", @@ -608,7 +1322,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ), name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( applied_on=["PDF","PPTX"], content_slide=ContentSlideTemplate( description_field="{{dashboardFilters}}", @@ -624,27 +1338,27 @@ with gooddata_api_client.ApiClient() as api_client: ), ), id="id1", - type="exportTemplate", + type="workspaceExportTemplate", ), - ) # JsonApiExportTemplateInDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiWorkspaceExportTemplateInDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # PUT Export Template entity - api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document) + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->update_entity_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # PUT Export Template entity - api_response = api_instance.update_entity_export_templates(id, json_api_export_template_in_document, filter=filter) + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ExportTemplatesApi->update_entity_export_templates: %s\n" % e) + print("Exception when calling ExportTemplatesApi->update_entity_workspace_export_templates: %s\n" % e) ``` @@ -652,13 +1366,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_in_document** | [**JsonApiExportTemplateInDocument**](JsonApiExportTemplateInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_in_document** | [**JsonApiWorkspaceExportTemplateInDocument**](JsonApiWorkspaceExportTemplateInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) ### Authorization diff --git a/gooddata-api-client/docs/FailedOperation.md b/gooddata-api-client/docs/FailedOperation.md index aa4537b8a..dc1bd115e 100644 --- a/gooddata-api-client/docs/FailedOperation.md +++ b/gooddata-api-client/docs/FailedOperation.md @@ -8,7 +8,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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | -**status** | **str** | | +**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] [[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/FilterDefinition.md b/gooddata-api-client/docs/FilterDefinition.md index f4fcb4948..f7e937e93 100644 --- a/gooddata-api-client/docs/FilterDefinition.md +++ b/gooddata-api-client/docs/FilterDefinition.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **range_measure_value_filter** | [**RangeMeasureValueFilterRangeMeasureValueFilter**](RangeMeasureValueFilterRangeMeasureValueFilter.md) | | [optional] **compound_measure_value_filter** | [**CompoundMeasureValueFilterCompoundMeasureValueFilter**](CompoundMeasureValueFilterCompoundMeasureValueFilter.md) | | [optional] **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] +**absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.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 5826ccfce..0df25771a 100644 --- a/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md +++ b/gooddata-api-client/docs/FilterDefinitionForSimpleMeasure.md @@ -6,6 +6,7 @@ Abstract filter definition type for simple metric. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **absolute_date_filter** | [**AbsoluteDateFilterAbsoluteDateFilter**](AbsoluteDateFilterAbsoluteDateFilter.md) | | [optional] +**absolute_granularity_date_filter** | [**AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter**](AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.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/FiscalCalendarControllerApi.md b/gooddata-api-client/docs/FiscalCalendarControllerApi.md new file mode 100644 index 000000000..5e0a8b443 --- /dev/null +++ b/gooddata-api-client/docs/FiscalCalendarControllerApi.md @@ -0,0 +1,182 @@ +# gooddata_api_client.FiscalCalendarControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_fiscal_calendars**](FiscalCalendarControllerApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars +[**get_entity_fiscal_calendars**](FiscalCalendarControllerApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar + + +# **get_all_entities_fiscal_calendars** +> JsonApiFiscalCalendarOutList get_all_entities_fiscal_calendars(workspace_id) + +Get all Fiscal Calendars + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fiscal_calendar_controller_api +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList +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 = fiscal_calendar_controller_api.FiscalCalendarControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarControllerApi->get_all_entities_fiscal_calendars: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarControllerApi->get_all_entities_fiscal_calendars: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFiscalCalendarOutList**](JsonApiFiscalCalendarOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_fiscal_calendars** +> JsonApiFiscalCalendarOutDocument get_entity_fiscal_calendars(workspace_id, object_id) + +Get a Fiscal Calendar + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fiscal_calendar_controller_api +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +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 = fiscal_calendar_controller_api.FiscalCalendarControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + 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: + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarControllerApi->get_entity_fiscal_calendars: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarControllerApi->get_entity_fiscal_calendars: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFiscalCalendarOutDocument**](JsonApiFiscalCalendarOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + diff --git a/gooddata-api-client/docs/FiscalCalendarsApi.md b/gooddata-api-client/docs/FiscalCalendarsApi.md new file mode 100644 index 000000000..ea064c25a --- /dev/null +++ b/gooddata-api-client/docs/FiscalCalendarsApi.md @@ -0,0 +1,182 @@ +# gooddata_api_client.FiscalCalendarsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_entities_fiscal_calendars**](FiscalCalendarsApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars +[**get_entity_fiscal_calendars**](FiscalCalendarsApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar + + +# **get_all_entities_fiscal_calendars** +> JsonApiFiscalCalendarOutList get_all_entities_fiscal_calendars(workspace_id) + +Get all Fiscal Calendars + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fiscal_calendars_api +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList +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 = fiscal_calendars_api.FiscalCalendarsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarsApi->get_all_entities_fiscal_calendars: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarsApi->get_all_entities_fiscal_calendars: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiFiscalCalendarOutList**](JsonApiFiscalCalendarOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_fiscal_calendars** +> JsonApiFiscalCalendarOutDocument get_entity_fiscal_calendars(workspace_id, object_id) + +Get a Fiscal Calendar + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import fiscal_calendars_api +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +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 = fiscal_calendars_api.FiscalCalendarsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + 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: + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarsApi->get_entity_fiscal_calendars: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FiscalCalendarsApi->get_entity_fiscal_calendars: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiFiscalCalendarOutDocument**](JsonApiFiscalCalendarOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + diff --git a/gooddata-api-client/docs/FiscalYearCalendarDefinition.md b/gooddata-api-client/docs/FiscalYearCalendarDefinition.md new file mode 100644 index 000000000..954971312 --- /dev/null +++ b/gooddata-api-client/docs/FiscalYearCalendarDefinition.md @@ -0,0 +1,14 @@ +# FiscalYearCalendarDefinition + +Algorithmic fiscal calendar derived by shifting the Gregorian year start. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month_offset** | **int** | Number of months the fiscal year start is shifted relative to the Gregorian year. | +**type** | **str** | | defaults to "fiscalYear" +**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/FiscalYearCalendarDefinitionAllOf.md b/gooddata-api-client/docs/FiscalYearCalendarDefinitionAllOf.md new file mode 100644 index 000000000..230b6a3fd --- /dev/null +++ b/gooddata-api-client/docs/FiscalYearCalendarDefinitionAllOf.md @@ -0,0 +1,12 @@ +# FiscalYearCalendarDefinitionAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**month_offset** | **int** | Number of months the fiscal year start is shifted relative to the Gregorian year. | [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/GenAiRankingFilter.md b/gooddata-api-client/docs/GenAiRankingFilter.md new file mode 100644 index 000000000..1c11c9027 --- /dev/null +++ b/gooddata-api-client/docs/GenAiRankingFilter.md @@ -0,0 +1,15 @@ +# GenAiRankingFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**measures** | **[str]** | | +**operator** | **str** | | +**value** | **int** | | +**dimensionality** | **[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/GenAiRankingFilterAllOf.md b/gooddata-api-client/docs/GenAiRankingFilterAllOf.md new file mode 100644 index 000000000..86aa7a0fa --- /dev/null +++ b/gooddata-api-client/docs/GenAiRankingFilterAllOf.md @@ -0,0 +1,15 @@ +# GenAiRankingFilterAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimensionality** | **[str]** | | [optional] +**measures** | **[str]** | | [optional] +**operator** | **str** | | [optional] +**value** | **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/HashDistributionConfig.md b/gooddata-api-client/docs/HashDistributionConfig.md index e3e78f354..eb3021160 100644 --- a/gooddata-api-client/docs/HashDistributionConfig.md +++ b/gooddata-api-client/docs/HashDistributionConfig.md @@ -5,6 +5,7 @@ Hash-based distribution across buckets. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "hash" **buckets** | **int** | Number of hash buckets. Defaults to 1. | [optional] **columns** | **[str]** | Columns to distribute by. Defaults to first column. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/IdentifierRef.md b/gooddata-api-client/docs/IdentifierRef.md index 31879332c..56fe1342b 100644 --- a/gooddata-api-client/docs/IdentifierRef.md +++ b/gooddata-api-client/docs/IdentifierRef.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**identifier** | [**IdentifierRefIdentifier**](IdentifierRefIdentifier.md) | | [optional] +**identifier** | [**IdentifierRefIdentifier**](IdentifierRefIdentifier.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/ImageExportApi.md b/gooddata-api-client/docs/ImageExportApi.md index 52aa305f1..a08af2104 100644 --- a/gooddata-api-client/docs/ImageExportApi.md +++ b/gooddata-api-client/docs/ImageExportApi.md @@ -43,6 +43,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], diff --git a/gooddata-api-client/docs/ImageExportRequest.md b/gooddata-api-client/docs/ImageExportRequest.md index 13a9a99ff..8abfcf094 100644 --- a/gooddata-api-client/docs/ImageExportRequest.md +++ b/gooddata-api-client/docs/ImageExportRequest.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | **format** | **str** | Requested resulting file type. | defaults to "PNG" **metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[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/IndefiniteCacheRetention.md b/gooddata-api-client/docs/IndefiniteCacheRetention.md new file mode 100644 index 000000000..55e284d00 --- /dev/null +++ b/gooddata-api-client/docs/IndefiniteCacheRetention.md @@ -0,0 +1,13 @@ +# IndefiniteCacheRetention + +The cache never expires on its own; it is kept per `cacheStrategy` and invalidated only explicitly. Equivalent to setting no policy at all. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The cache retention type. | defaults to "INDEFINITE" +**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/InsightWidgetDescriptor.md b/gooddata-api-client/docs/InsightWidgetDescriptor.md index 7c52bfb77..be87d25df 100644 --- a/gooddata-api-client/docs/InsightWidgetDescriptor.md +++ b/gooddata-api-client/docs/InsightWidgetDescriptor.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **title** | **str** | Widget title as displayed on the dashboard. | **visualization_id** | **str** | Visualization object ID referenced by this insight widget. | **widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | defaults to "insight" **filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [optional] **result_id** | **str** | Signed result ID for this widget's cached execution result. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md index af5574d04..81e8ac286 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md @@ -8,6 +8,8 @@ Name | Type | Description | Notes **schema** | **str** | The schema to use as the root of the data for the data source. | **type** | **str** | Type of the database providing the data for the data source. | **alternative_data_source_id** | **str, none_type** | Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source. | [optional] +**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] +**cache_retention** | [**JsonApiDataSourceInAttributesCacheRetention**](JsonApiDataSourceInAttributesCacheRetention.md) | | [optional] **cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] diff --git a/gooddata-api-client/docs/JsonApiDataSourceInAttributesCacheRetention.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributesCacheRetention.md new file mode 100644 index 000000000..58af9261e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributesCacheRetention.md @@ -0,0 +1,15 @@ +# JsonApiDataSourceInAttributesCacheRetention + +Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The cache retention type. | [optional] if omitted the server will use the default value of "VALIDITY_PERIOD" +**schedule** | [**CacheRetentionSchedule**](CacheRetentionSchedule.md) | | [optional] +**validity_period** | **str** | How long the cached results stay valid after they were computed. | [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/JsonApiDataSourceOutAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md index b53ccc4b9..b841a470b 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md @@ -9,10 +9,12 @@ Name | Type | Description | Notes **type** | **str** | Type of the database providing the data for the data source. | **alternative_data_source_id** | **str, none_type** | Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source. | [optional] **authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] +**cache_retention** | [**JsonApiDataSourceInAttributesCacheRetention**](JsonApiDataSourceInAttributesCacheRetention.md) | | [optional] **cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **date_time_semantics** | **str, none_type** | Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this. | [optional] **decoded_parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Decoded parameters to be used when connecting to the database providing the data for the data source. | [optional] +**managed** | **bool** | Whether the object is platform-managed and read-only. | [optional] **parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Additional parameters to be used when connecting to the database providing the data for the data source. | [optional] **url** | **str, none_type** | The URL of the database providing the data for the data source. | [optional] **username** | **str, none_type** | The username to use to connect to the database providing the data for the data source. | [optional] diff --git a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md index 949acd5cd..8713bafb0 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md @@ -5,6 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alternative_data_source_id** | **str, none_type** | Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source. | [optional] +**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. | [optional] +**cache_retention** | [**JsonApiDataSourceInAttributesCacheRetention**](JsonApiDataSourceInAttributesCacheRetention.md) | | [optional] **cache_strategy** | **str, none_type** | Determines how the results coming from a particular datasource should be cached. | [optional] **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md index 98f7a0841..1337fc379 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md @@ -6,12 +6,16 @@ JSON content to be used as export request payload for /export/tabular and /expor Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**executions** | [**[TabularExportExecution]**](TabularExportExecution.md) | Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride. | [optional] **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] **visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] +**visualization_object_custom_parameters** | [**[ParameterValue]**](ParameterValue.md) | Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization. | [optional] **dashboard_id** | **str** | Dashboard identifier | [optional] **file_name** | **str** | Filename of downloaded file without extension. | [optional] **format** | **str** | Expected file format. | [optional] diff --git a/gooddata-api-client/docs/AutomationAlertCondition.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOut.md similarity index 61% rename from gooddata-api-client/docs/AutomationAlertCondition.md rename to gooddata-api-client/docs/JsonApiFiscalCalendarOut.md index 072e4c0ba..11522c9da 100644 --- a/gooddata-api-client/docs/AutomationAlertCondition.md +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOut.md @@ -1,13 +1,13 @@ -# AutomationAlertCondition +# JsonApiFiscalCalendarOut +A custom fiscal calendar. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**anomaly** | [**AnomalyDetection**](AnomalyDetection.md) | | [optional] -**comparison** | [**Comparison**](Comparison.md) | | [optional] -**range** | [**Range**](Range.md) | | [optional] -**relative** | [**Relative**](Relative.md) | | [optional] +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "fiscalCalendar" +**attributes** | [**JsonApiFiscalCalendarOutAttributes**](JsonApiFiscalCalendarOutAttributes.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/JsonApiFiscalCalendarOutAttributes.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributes.md new file mode 100644 index 000000000..6a9ffdb90 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributes.md @@ -0,0 +1,17 @@ +# JsonApiFiscalCalendarOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**definition** | [**JsonApiFiscalCalendarOutAttributesDefinition**](JsonApiFiscalCalendarOutAttributesDefinition.md) | | [optional] +**description** | **str** | Calendar description. | [optional] +**enabled_granularities** | [**[JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner]**](JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md) | Granularities available in the calendar, in drill-down order (finest to coarsest). Granularity title prefixes are localizable. | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | Calendar title. | [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/JsonApiFiscalCalendarOutAttributesDefinition.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributesDefinition.md new file mode 100644 index 000000000..98ec0f0b5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributesDefinition.md @@ -0,0 +1,14 @@ +# JsonApiFiscalCalendarOutAttributesDefinition + +Calendar definition details based on the calendar type. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_tables** | [**{str: (CalendarTableReference,)}**](CalendarTableReference.md) | Custom fiscal calendar table per data source ID. | [optional] +**month_offset** | **int** | Number of months the fiscal year start is shifted relative to the Gregorian year. | [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/JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md new file mode 100644 index 000000000..0eaf92967 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner.md @@ -0,0 +1,14 @@ +# JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner + +A fiscal granularity enabled in a calendar together with its title prefix. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**granularity** | **str** | Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. | +**prefix** | **str** | Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. | +**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/JsonApiFiscalCalendarOutDocument.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutDocument.md new file mode 100644 index 000000000..13e6b8535 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiFiscalCalendarOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiFiscalCalendarOut**](JsonApiFiscalCalendarOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiFiscalCalendarOutList.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutList.md new file mode 100644 index 000000000..40115da1a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutList.md @@ -0,0 +1,15 @@ +# JsonApiFiscalCalendarOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiFiscalCalendarOutWithLinks]**](JsonApiFiscalCalendarOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.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/JsonApiFiscalCalendarOutWithLinks.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutWithLinks.md new file mode 100644 index 000000000..1d085552c --- /dev/null +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutWithLinks.md @@ -0,0 +1,15 @@ +# JsonApiFiscalCalendarOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "fiscalCalendar" +**attributes** | [**JsonApiFiscalCalendarOutAttributes**](JsonApiFiscalCalendarOutAttributes.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiOrgMemoryItemIn.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemIn.md new file mode 100644 index 000000000..26c991de7 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemIn.md @@ -0,0 +1,15 @@ +# JsonApiOrgMemoryItemIn + +Organization-scoped AI memory item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiOrgMemoryItemInAttributes**](JsonApiOrgMemoryItemInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "orgMemoryItem" +**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/JsonApiOrgMemoryItemInAttributes.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemInAttributes.md new file mode 100644 index 000000000..f6b0a7288 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemInAttributes.md @@ -0,0 +1,17 @@ +# JsonApiOrgMemoryItemInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instruction** | **str** | The text that will be injected into the system prompt | +**strategy** | **str** | Strategy defining when the memory item should be applied | +**description** | **str, none_type** | | [optional] +**is_disabled** | **bool** | Whether memory item is disabled | [optional] +**keywords** | **[str]** | Set of unique strings used for semantic similarity filtering | [optional] +**title** | **str, 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/PipeTableKeyConfig.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemInDocument.md similarity index 80% rename from gooddata-api-client/docs/PipeTableKeyConfig.md rename to gooddata-api-client/docs/JsonApiOrgMemoryItemInDocument.md index ae4a6f9bc..b81b619f1 100644 --- a/gooddata-api-client/docs/PipeTableKeyConfig.md +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemInDocument.md @@ -1,10 +1,10 @@ -# PipeTableKeyConfig +# JsonApiOrgMemoryItemInDocument ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] +**data** | [**JsonApiOrgMemoryItemIn**](JsonApiOrgMemoryItemIn.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/JsonApiOrgMemoryItemOut.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOut.md new file mode 100644 index 000000000..ec0463a0f --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOut.md @@ -0,0 +1,16 @@ +# JsonApiOrgMemoryItemOut + +Organization-scoped AI memory item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiOrgMemoryItemOutAttributes**](JsonApiOrgMemoryItemOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "orgMemoryItem" +**relationships** | [**JsonApiDashboardPluginOutRelationships**](JsonApiDashboardPluginOutRelationships.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/JsonApiOrgMemoryItemOutAttributes.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutAttributes.md new file mode 100644 index 000000000..d17fe89a8 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutAttributes.md @@ -0,0 +1,19 @@ +# JsonApiOrgMemoryItemOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instruction** | **str** | The text that will be injected into the system prompt | +**strategy** | **str** | Strategy defining when the memory item should be applied | +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] +**description** | **str, none_type** | | [optional] +**is_disabled** | **bool** | Whether memory item is disabled | [optional] +**keywords** | **[str]** | Set of unique strings used for semantic similarity filtering | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] +**title** | **str, 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/JsonApiOrgMemoryItemOutDocument.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutDocument.md new file mode 100644 index 000000000..e19e09473 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutDocument.md @@ -0,0 +1,14 @@ +# JsonApiOrgMemoryItemOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiOrgMemoryItemOut**](JsonApiOrgMemoryItemOut.md) | | +**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiOrgMemoryItemOutList.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutList.md new file mode 100644 index 000000000..5d6fa2b92 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutList.md @@ -0,0 +1,16 @@ +# JsonApiOrgMemoryItemOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiOrgMemoryItemOutWithLinks]**](JsonApiOrgMemoryItemOutWithLinks.md) | | +**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.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/JsonApiOrgMemoryItemOutWithLinks.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutWithLinks.md new file mode 100644 index 000000000..801e9a242 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutWithLinks.md @@ -0,0 +1,16 @@ +# JsonApiOrgMemoryItemOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiOrgMemoryItemOutAttributes**](JsonApiOrgMemoryItemOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "orgMemoryItem" +**relationships** | [**JsonApiDashboardPluginOutRelationships**](JsonApiDashboardPluginOutRelationships.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiOrgMemoryItemPatch.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatch.md new file mode 100644 index 000000000..6d3ca2767 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatch.md @@ -0,0 +1,15 @@ +# JsonApiOrgMemoryItemPatch + +Organization-scoped AI memory item. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiOrgMemoryItemPatchAttributes**](JsonApiOrgMemoryItemPatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "orgMemoryItem" +**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/JsonApiOrgMemoryItemPatchAttributes.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatchAttributes.md new file mode 100644 index 000000000..1ebabb280 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatchAttributes.md @@ -0,0 +1,17 @@ +# JsonApiOrgMemoryItemPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str, none_type** | | [optional] +**instruction** | **str** | The text that will be injected into the system prompt | [optional] +**is_disabled** | **bool** | Whether memory item is disabled | [optional] +**keywords** | **[str]** | Set of unique strings used for semantic similarity filtering | [optional] +**strategy** | **str** | Strategy defining when the memory item should be applied | [optional] +**title** | **str, 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/JsonApiOrgMemoryItemPatchDocument.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatchDocument.md new file mode 100644 index 000000000..7b256b240 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemPatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiOrgMemoryItemPatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiOrgMemoryItemPatch**](JsonApiOrgMemoryItemPatch.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/JsonApiWorkspaceAutomationOutIncludes.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md index 214ec1d12..c2b8c8662 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutIncludes.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **meta** | [**JsonApiWorkspaceOutMeta**](JsonApiWorkspaceOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**attributes** | [**JsonApiWorkspaceOutAttributes**](JsonApiWorkspaceOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] **type** | **str** | Object type | [optional] if omitted the server will use the default value of "workspace" **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/JsonApiWorkspaceColorPaletteIn.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteIn.md new file mode 100644 index 000000000..d21da2905 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteIn.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceColorPaletteIn + +JSON:API representation of workspaceColorPalette entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceColorPalette" +**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/JsonApiWorkspaceColorPaletteInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteInDocument.md new file mode 100644 index 000000000..f8d741635 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteInDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceColorPaletteInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceColorPaletteIn**](JsonApiWorkspaceColorPaletteIn.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/JsonApiWorkspaceColorPaletteOut.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOut.md new file mode 100644 index 000000000..1eb1a4440 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOut.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceColorPaletteOut + +JSON:API representation of workspaceColorPalette entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceColorPalette" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.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/JsonApiWorkspaceColorPaletteOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutDocument.md new file mode 100644 index 000000000..4967339c8 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiWorkspaceColorPaletteOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceColorPaletteOut**](JsonApiWorkspaceColorPaletteOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceColorPaletteOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md new file mode 100644 index 000000000..3cc815907 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceColorPaletteOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiWorkspaceColorPaletteOutWithLinks]**](JsonApiWorkspaceColorPaletteOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.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/JsonApiWorkspaceColorPaletteOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutWithLinks.md new file mode 100644 index 000000000..971308a40 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutWithLinks.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceColorPaletteOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceColorPalette" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceColorPalettePatch.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPalettePatch.md new file mode 100644 index 000000000..bff116457 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPalettePatch.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceColorPalettePatch + +JSON:API representation of patching workspaceColorPalette entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPalettePatchAttributes**](JsonApiColorPalettePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceColorPalette" +**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/JsonApiWorkspaceColorPalettePatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPalettePatchDocument.md new file mode 100644 index 000000000..919dbfb48 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPalettePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceColorPalettePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceColorPalettePatch**](JsonApiWorkspaceColorPalettePatch.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/JsonApiWorkspaceExportTemplateIn.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateIn.md new file mode 100644 index 000000000..4cc1868b1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateIn.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceExportTemplateIn + +JSON:API representation of workspaceExportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceExportTemplateInAttributes**](JsonApiWorkspaceExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceExportTemplate" +**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/JsonApiWorkspaceExportTemplateInAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributes.md new file mode 100644 index 000000000..f08d2c2b1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributes.md @@ -0,0 +1,14 @@ +# JsonApiWorkspaceExportTemplateInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | User-facing name of the Slides template. | +**dashboard_slides_template** | [**JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] +**widget_slides_template** | [**JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.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/JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md new file mode 100644 index 000000000..6979fe6ba --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md @@ -0,0 +1,17 @@ +# JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate + +Template for workspace dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.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/JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.md new file mode 100644 index 000000000..003291603 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.md @@ -0,0 +1,14 @@ +# JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate + +Template for workspace widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.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/JsonApiWorkspaceExportTemplateInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInDocument.md new file mode 100644 index 000000000..e6f9568cb --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateInDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceExportTemplateInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceExportTemplateIn**](JsonApiWorkspaceExportTemplateIn.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/JsonApiWorkspaceExportTemplateOut.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOut.md new file mode 100644 index 000000000..cb90de74b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOut.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceExportTemplateOut + +JSON:API representation of workspaceExportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceExportTemplateInAttributes**](JsonApiWorkspaceExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceExportTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.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/JsonApiWorkspaceExportTemplateOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutDocument.md new file mode 100644 index 000000000..699528eba --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiWorkspaceExportTemplateOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceExportTemplateOut**](JsonApiWorkspaceExportTemplateOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceExportTemplateOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutList.md new file mode 100644 index 000000000..d7a250b37 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutList.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceExportTemplateOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiWorkspaceExportTemplateOutWithLinks]**](JsonApiWorkspaceExportTemplateOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.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/JsonApiWorkspaceExportTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutWithLinks.md new file mode 100644 index 000000000..1581e9521 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutWithLinks.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceExportTemplateOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceExportTemplateInAttributes**](JsonApiWorkspaceExportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceExportTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceExportTemplatePatch.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatch.md new file mode 100644 index 000000000..e35973788 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatch.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceExportTemplatePatch + +JSON:API representation of patching workspaceExportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceExportTemplatePatchAttributes**](JsonApiWorkspaceExportTemplatePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceExportTemplate" +**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/JsonApiWorkspaceExportTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatchAttributes.md new file mode 100644 index 000000000..781800b63 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatchAttributes.md @@ -0,0 +1,14 @@ +# JsonApiWorkspaceExportTemplatePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dashboard_slides_template** | [**JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate**](JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate.md) | | [optional] +**name** | **str** | User-facing name of the Slides template. | [optional] +**widget_slides_template** | [**JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate**](JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate.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/JsonApiWorkspaceExportTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatchDocument.md new file mode 100644 index 000000000..ace02e5e0 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceExportTemplatePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceExportTemplatePatch**](JsonApiWorkspaceExportTemplatePatch.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/JsonApiWorkspaceExportTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePostOptionalId.md new file mode 100644 index 000000000..526398fe6 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceExportTemplatePostOptionalId + +JSON:API representation of workspaceExportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiWorkspaceExportTemplateInAttributes**](JsonApiWorkspaceExportTemplateInAttributes.md) | | +**type** | **str** | Object type | defaults to "workspaceExportTemplate" +**id** | **str** | API identifier of an object | [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/JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..6fb3ed043 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceExportTemplatePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceExportTemplatePostOptionalId**](JsonApiWorkspaceExportTemplatePostOptionalId.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/JsonApiWorkspaceOut.md b/gooddata-api-client/docs/JsonApiWorkspaceOut.md index 87b21321d..366f3ff3a 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOut.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspace" -**attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**attributes** | [**JsonApiWorkspaceOutAttributes**](JsonApiWorkspaceOutAttributes.md) | | [optional] **meta** | [**JsonApiWorkspaceOutMeta**](JsonApiWorkspaceOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.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/JsonApiWorkspaceOutAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceOutAttributes.md new file mode 100644 index 000000000..2c3043e29 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutAttributes.md @@ -0,0 +1,19 @@ +# JsonApiWorkspaceOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cache_extra_limit** | **int** | | [optional] +**data_source** | [**JsonApiWorkspaceInAttributesDataSource**](JsonApiWorkspaceInAttributesDataSource.md) | | [optional] +**description** | **str, none_type** | | [optional] +**early_access** | **str, none_type** | The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues. | [optional] +**early_access_values** | **[str], none_type** | The early access feature identifiers. They are used to enable experimental features. | [optional] +**managed** | **bool** | Whether the object is platform-managed and read-only. | [optional] +**name** | **str, none_type** | | [optional] +**prefix** | **str, none_type** | Custom prefix of entity identifiers in 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/JsonApiWorkspaceOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md index 612ae493a..dbb623e40 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutWithLinks.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspace" -**attributes** | [**JsonApiWorkspaceInAttributes**](JsonApiWorkspaceInAttributes.md) | | [optional] +**attributes** | [**JsonApiWorkspaceOutAttributes**](JsonApiWorkspaceOutAttributes.md) | | [optional] **meta** | [**JsonApiWorkspaceOutMeta**](JsonApiWorkspaceOutMeta.md) | | [optional] **relationships** | [**JsonApiWorkspaceInRelationships**](JsonApiWorkspaceInRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceThemeIn.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeIn.md new file mode 100644 index 000000000..bfce80cf0 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeIn.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceThemeIn + +JSON:API representation of workspaceTheme entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceTheme" +**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/JsonApiWorkspaceThemeInDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeInDocument.md new file mode 100644 index 000000000..6468f4b67 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeInDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceThemeInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceThemeIn**](JsonApiWorkspaceThemeIn.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/JsonApiWorkspaceThemeOut.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeOut.md new file mode 100644 index 000000000..96b387ad7 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeOut.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceThemeOut + +JSON:API representation of workspaceTheme entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceTheme" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.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/JsonApiWorkspaceThemeOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutDocument.md new file mode 100644 index 000000000..a6efab707 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutDocument.md @@ -0,0 +1,13 @@ +# JsonApiWorkspaceThemeOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceThemeOut**](JsonApiWorkspaceThemeOut.md) | | +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceThemeOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md new file mode 100644 index 000000000..542e74fc2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceThemeOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiWorkspaceThemeOutWithLinks]**](JsonApiWorkspaceThemeOutWithLinks.md) | | +**links** | [**ListLinks**](ListLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.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/JsonApiWorkspaceThemeOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutWithLinks.md new file mode 100644 index 000000000..b84374fa9 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutWithLinks.md @@ -0,0 +1,16 @@ +# JsonApiWorkspaceThemeOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPaletteInAttributes**](JsonApiColorPaletteInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceTheme" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**links** | [**ObjectLinks**](ObjectLinks.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/JsonApiWorkspaceThemePatch.md b/gooddata-api-client/docs/JsonApiWorkspaceThemePatch.md new file mode 100644 index 000000000..1c92994b0 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemePatch.md @@ -0,0 +1,15 @@ +# JsonApiWorkspaceThemePatch + +JSON:API representation of patching workspaceTheme entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiColorPalettePatchAttributes**](JsonApiColorPalettePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "workspaceTheme" +**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/JsonApiWorkspaceThemePatchDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceThemePatchDocument.md new file mode 100644 index 000000000..7e9b9226a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiWorkspaceThemePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiWorkspaceThemePatch**](JsonApiWorkspaceThemePatch.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/LDMDeclarativeAPIsApi.md b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md index 1110a5605..14e759afb 100644 --- a/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md @@ -116,6 +116,19 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | declarative_model = DeclarativeModel( ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -280,7 +293,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index b23c130d2..00d5029a6 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -1885,6 +1885,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDataSource( alternative_data_source_id="pg_local_docker-demo2", authentication_type="USERNAME_PASSWORD", + cache_retention=CacheRetention(), cache_strategy="ALWAYS", client_id="client1234", client_secret="client_secret_example", @@ -1907,7 +1908,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -2002,7 +2003,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -2087,7 +2088,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -2189,7 +2190,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -2207,7 +2208,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -2388,7 +2389,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -2456,7 +2457,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -2502,6 +2503,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -2666,7 +2680,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -2766,7 +2780,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - name="Default GoodData AI Assistant", + name="Default AI Assistant", personality="personality_example", skills_mode="all", user_groups=[ @@ -2936,7 +2950,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -3004,7 +3018,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -3120,7 +3134,7 @@ with gooddata_api_client.ApiClient() as api_client: declarative_automation = [ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -3150,15 +3164,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -3181,11 +3187,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -3194,13 +3196,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -3239,6 +3242,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -3315,20 +3319,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -3355,6 +3352,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -3382,6 +3380,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -3413,6 +3435,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -3426,6 +3451,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], @@ -3576,7 +3602,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -3966,6 +3992,19 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | declarative_model = DeclarativeModel( ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -4130,7 +4169,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -4216,7 +4255,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_dashboard_url="custom_dashboard_url_example", dashboard_link_visibility="INTERNAL_ONLY", description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), id="notification-channel-1", in_platform_notification="DISABLED", name="channel", @@ -4310,7 +4349,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - name="Default GoodData AI Assistant", + name="Default AI Assistant", personality="personality_example", skills_mode="all", user_groups=[ @@ -4332,6 +4371,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDataSource( alternative_data_source_id="pg_local_docker-demo2", authentication_type="USERNAME_PASSWORD", + cache_retention=CacheRetention(), cache_strategy="ALWAYS", client_id="client1234", client_secret="client_secret_example", @@ -4354,7 +4394,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -4494,7 +4534,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_dashboard_url="custom_dashboard_url_example", dashboard_link_visibility="INTERNAL_ONLY", description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), id="notification-channel-1", in_platform_notification="DISABLED", name="channel", @@ -4534,7 +4574,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeOrganizationPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -4568,7 +4608,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -4586,7 +4626,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -4637,7 +4677,7 @@ with gooddata_api_client.ApiClient() as api_client: automations=[ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -4667,15 +4707,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -4698,11 +4730,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -4711,13 +4739,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -4756,6 +4785,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -4832,20 +4862,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -4872,6 +4895,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -4899,6 +4923,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -4930,6 +4978,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -4943,12 +4994,20 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], ), ], cache_extra_limit=1, + color_palettes=[ + DeclarativeWorkspaceColorPalette( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", @@ -4967,6 +5026,79 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + export_templates=[ + DeclarativeWorkspaceExportTemplate( + dashboard_slides_template=WorkspaceDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WorkspaceWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], filter_views=[ DeclarativeFilterView( analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -4990,7 +5122,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -5089,7 +5221,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -5157,7 +5289,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -5203,6 +5335,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -5367,7 +5512,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -5388,7 +5533,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -5402,6 +5547,13 @@ with gooddata_api_client.ApiClient() as api_client: type="TIMEZONE", ), ], + themes=[ + DeclarativeWorkspaceTheme( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], user_data_filters=[ DeclarativeUserDataFilter( description="ID of country setting", @@ -5490,7 +5642,7 @@ with gooddata_api_client.ApiClient() as api_client: declarative_organization_permission = [ DeclarativeOrganizationPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -5652,7 +5804,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -5730,7 +5882,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -5899,7 +6051,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -5908,7 +6060,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -6011,7 +6163,7 @@ with gooddata_api_client.ApiClient() as api_client: automations=[ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -6041,15 +6193,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -6072,11 +6216,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -6085,13 +6225,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -6130,6 +6271,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -6206,20 +6348,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -6246,6 +6381,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -6273,6 +6409,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -6304,6 +6464,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -6317,12 +6480,20 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], ), ], cache_extra_limit=1, + color_palettes=[ + DeclarativeWorkspaceColorPalette( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", @@ -6341,6 +6512,79 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + export_templates=[ + DeclarativeWorkspaceExportTemplate( + dashboard_slides_template=WorkspaceDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WorkspaceWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], filter_views=[ DeclarativeFilterView( analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -6364,7 +6608,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -6463,7 +6707,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -6531,7 +6775,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -6577,6 +6821,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -6741,7 +6998,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -6762,7 +7019,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -6776,6 +7033,13 @@ with gooddata_api_client.ApiClient() as api_client: type="TIMEZONE", ), ], + themes=[ + DeclarativeWorkspaceTheme( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], user_data_filters=[ DeclarativeUserDataFilter( description="ID of country setting", diff --git a/gooddata-api-client/docs/ListLlmProviderModelsRequest.md b/gooddata-api-client/docs/ListLlmProviderModelsRequest.md index 8432da2c1..3ac7594a3 100644 --- a/gooddata-api-client/docs/ListLlmProviderModelsRequest.md +++ b/gooddata-api-client/docs/ListLlmProviderModelsRequest.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | +**provider_config** | [**LlmProviderConfig**](LlmProviderConfig.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/ListLlmProviderModelsRequestProviderConfig.md b/gooddata-api-client/docs/ListLlmProviderModelsRequestProviderConfig.md deleted file mode 100644 index 1119c6461..000000000 --- a/gooddata-api-client/docs/ListLlmProviderModelsRequestProviderConfig.md +++ /dev/null @@ -1,17 +0,0 @@ -# ListLlmProviderModelsRequestProviderConfig - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**base_url** | **str** | Custom base URL for OpenAI API. | [optional] if omitted the server will use the default value of "https://api.openai.com/v1" -**organization** | **str, none_type** | OpenAI organization ID. | [optional] -**auth** | [**OpenAiProviderAuth**](OpenAiProviderAuth.md) | | [optional] -**type** | **str** | Provider type. | [optional] if omitted the server will use the default value of "OPENAI" -**region** | **str** | AWS region for Bedrock. | [optional] -**endpoint** | **str** | Azure OpenAI endpoint URL. | [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/ManageMetricPermissionsRequestInner.md b/gooddata-api-client/docs/ManageMetricPermissionsRequestInner.md new file mode 100644 index 000000000..535822658 --- /dev/null +++ b/gooddata-api-client/docs/ManageMetricPermissionsRequestInner.md @@ -0,0 +1,14 @@ +# ManageMetricPermissionsRequestInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | [optional] +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] +**assignee_rule** | [**AssigneeRule**](AssigneeRule.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/ManagePermissionsApi.md b/gooddata-api-client/docs/ManagePermissionsApi.md index 32a0948d7..afddc5764 100644 --- a/gooddata-api-client/docs/ManagePermissionsApi.md +++ b/gooddata-api-client/docs/ManagePermissionsApi.md @@ -107,7 +107,7 @@ with gooddata_api_client.ApiClient() as api_client: data_source_permission_assignment = [ DataSourcePermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), permissions=[ @@ -186,7 +186,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", diff --git a/gooddata-api-client/docs/MeasureItem.md b/gooddata-api-client/docs/MeasureItem.md index b6fd4a85b..7e6204059 100644 --- a/gooddata-api-client/docs/MeasureItem.md +++ b/gooddata-api-client/docs/MeasureItem.md @@ -5,7 +5,7 @@ Metric is a quantity that is calculated from the data. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**definition** | [**MeasureItemDefinition**](MeasureItemDefinition.md) | | +**definition** | [**MeasureDefinition**](MeasureDefinition.md) | | **local_identifier** | **str** | Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. | **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/MeasureItemDefinition.md b/gooddata-api-client/docs/MeasureItemDefinition.md deleted file mode 100644 index 1f49e6539..000000000 --- a/gooddata-api-client/docs/MeasureItemDefinition.md +++ /dev/null @@ -1,15 +0,0 @@ -# MeasureItemDefinition - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**arithmetic_measure** | [**ArithmeticMeasureDefinitionArithmeticMeasure**](ArithmeticMeasureDefinitionArithmeticMeasure.md) | | [optional] -**inline** | [**InlineMeasureDefinitionInline**](InlineMeasureDefinitionInline.md) | | [optional] -**previous_period_measure** | [**PopDatasetMeasureDefinitionPreviousPeriodMeasure**](PopDatasetMeasureDefinitionPreviousPeriodMeasure.md) | | [optional] -**over_period_measure** | [**PopDateMeasureDefinitionOverPeriodMeasure**](PopDateMeasureDefinitionOverPeriodMeasure.md) | | [optional] -**measure** | [**SimpleMeasureDefinitionMeasure**](SimpleMeasureDefinitionMeasure.md) | | [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/MetadataSyncApi.md b/gooddata-api-client/docs/MetadataSyncApi.md deleted file mode 100644 index bc6a8d307..000000000 --- a/gooddata-api-client/docs/MetadataSyncApi.md +++ /dev/null @@ -1,136 +0,0 @@ -# gooddata_api_client.MetadataSyncApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**metadata_sync**](MetadataSyncApi.md#metadata_sync) | **POST** /api/v1/actions/workspaces/{workspaceId}/metadataSync | (BETA) Sync Metadata to other services -[**metadata_sync_organization**](MetadataSyncApi.md#metadata_sync_organization) | **POST** /api/v1/actions/organization/metadataSync | (BETA) Sync organization scope Metadata to other services - - -# **metadata_sync** -> metadata_sync(workspace_id) - -(BETA) Sync Metadata to other services - -(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import metadata_sync_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 = metadata_sync_api.MetadataSyncApi(api_client) - workspace_id = "workspaceId_example" # str | - - # example passing only required values which don't have defaults set - try: - # (BETA) Sync Metadata to other services - api_instance.metadata_sync(workspace_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling MetadataSyncApi->metadata_sync: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**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) - -# **metadata_sync_organization** -> metadata_sync_organization() - -(BETA) Sync organization scope Metadata to other services - -(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import metadata_sync_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 = metadata_sync_api.MetadataSyncApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # (BETA) Sync organization scope Metadata to other services - api_instance.metadata_sync_organization() - except gooddata_api_client.ApiException as e: - print("Exception when calling MetadataSyncApi->metadata_sync_organization: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### 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 | -|-------------|-------------|------------------| -**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/MetricPermissions.md b/gooddata-api-client/docs/MetricPermissions.md new file mode 100644 index 000000000..245342635 --- /dev/null +++ b/gooddata-api-client/docs/MetricPermissions.md @@ -0,0 +1,14 @@ +# MetricPermissions + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rules** | [**[RulePermission]**](RulePermission.md) | List of rules | +**user_groups** | [**[UserGroupPermission]**](UserGroupPermission.md) | List of user groups | +**users** | [**[UserPermission]**](UserPermission.md) | List of users | +**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/MetricPermissionsAssignment.md b/gooddata-api-client/docs/MetricPermissionsAssignment.md new file mode 100644 index 000000000..7e4c7414e --- /dev/null +++ b/gooddata-api-client/docs/MetricPermissionsAssignment.md @@ -0,0 +1,13 @@ +# MetricPermissionsAssignment + +Desired levels of permissions on a metric for an assignee. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[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] + +[[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/MetricPermissionsForAssignee.md b/gooddata-api-client/docs/MetricPermissionsForAssignee.md new file mode 100644 index 000000000..feff93de5 --- /dev/null +++ b/gooddata-api-client/docs/MetricPermissionsForAssignee.md @@ -0,0 +1,14 @@ +# MetricPermissionsForAssignee + +Desired levels of metric permissions for an assignee identified by an identifier. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.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/MetricPermissionsForAssigneeRule.md b/gooddata-api-client/docs/MetricPermissionsForAssigneeRule.md new file mode 100644 index 000000000..74d60fc4e --- /dev/null +++ b/gooddata-api-client/docs/MetricPermissionsForAssigneeRule.md @@ -0,0 +1,14 @@ +# MetricPermissionsForAssigneeRule + +Desired levels of metric permissions for a collection of assignees identified by a rule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_rule** | [**AssigneeRule**](AssigneeRule.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/Notes.md b/gooddata-api-client/docs/Notes.md index eff8235b9..3ed862a5b 100644 --- a/gooddata-api-client/docs/Notes.md +++ b/gooddata-api-client/docs/Notes.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**note** | [**[Note]**](Note.md) | | [optional] +**note** | [**[Note]**](Note.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/NotificationChannelsApi.md b/gooddata-api-client/docs/NotificationChannelsApi.md index 4c606d992..7e22d2828 100644 --- a/gooddata-api-client/docs/NotificationChannelsApi.md +++ b/gooddata-api-client/docs/NotificationChannelsApi.md @@ -1078,7 +1078,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_dashboard_url="custom_dashboard_url_example", dashboard_link_visibility="INTERNAL_ONLY", description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), id="notification-channel-1", in_platform_notification="DISABLED", name="channel", @@ -1154,7 +1154,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = notification_channels_api.NotificationChannelsApi(api_client) notification_channel_id = "notificationChannelId_example" # str | test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), external_recipients=[ AutomationExternalRecipient( email="email_example", @@ -1239,7 +1239,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = notification_channels_api.NotificationChannelsApi(api_client) test_destination_request = TestDestinationRequest( - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), external_recipients=[ AutomationExternalRecipient( email="email_example", diff --git a/gooddata-api-client/docs/NotificationParameter.md b/gooddata-api-client/docs/NotificationParameter.md new file mode 100644 index 000000000..5dfa272eb --- /dev/null +++ b/gooddata-api-client/docs/NotificationParameter.md @@ -0,0 +1,14 @@ +# NotificationParameter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**value** | **str** | | +**title** | **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/OrgMemoryItemControllerApi.md b/gooddata-api-client/docs/OrgMemoryItemControllerApi.md new file mode 100644 index 000000000..f949bad7d --- /dev/null +++ b/gooddata-api-client/docs/OrgMemoryItemControllerApi.md @@ -0,0 +1,531 @@ +# gooddata_api_client.OrgMemoryItemControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_org_memory_items**](OrgMemoryItemControllerApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities +[**delete_entity_org_memory_items**](OrgMemoryItemControllerApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity +[**get_all_entities_org_memory_items**](OrgMemoryItemControllerApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities +[**get_entity_org_memory_items**](OrgMemoryItemControllerApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity +[**patch_entity_org_memory_items**](OrgMemoryItemControllerApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity +[**update_entity_org_memory_items**](OrgMemoryItemControllerApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity + + +# **create_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument create_entity_org_memory_items(json_api_org_memory_item_in_document) + +Post organization Memory Item entities + +Organization-scoped AI memory item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->create_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->create_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **delete_entity_org_memory_items** +> delete_entity_org_memory_items(id) + +Delete an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + + # example passing only required values which don't have defaults set + try: + # Delete an organization Memory Item entity + api_instance.delete_entity_org_memory_items(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->delete_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_org_memory_items** +> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() + +Get all organization Memory Item entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_api +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all organization Memory Item entities + api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->get_all_entities_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) + +Get an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_api +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->get_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->get_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **patch_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + +Patch an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_api +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( + data=JsonApiOrgMemoryItemPatch( + attributes=JsonApiOrgMemoryItemPatchAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->patch_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->patch_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **update_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + +Put an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import org_memory_item_controller_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +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 = org_memory_item_controller_api.OrgMemoryItemControllerApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->update_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling OrgMemoryItemControllerApi->update_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 3d93b16dd..9fdf84cdc 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -256,7 +256,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - name="Default GoodData AI Assistant", + name="Default AI Assistant", personality="personality_example", skills_mode="all", user_groups=[ @@ -428,7 +428,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - name="Default GoodData AI Assistant", + name="Default AI Assistant", personality="personality_example", skills_mode="all", user_groups=[ @@ -450,6 +450,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDataSource( alternative_data_source_id="pg_local_docker-demo2", authentication_type="USERNAME_PASSWORD", + cache_retention=CacheRetention(), cache_strategy="ALWAYS", client_id="client1234", client_secret="client_secret_example", @@ -472,7 +473,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeDataSourcePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -612,7 +613,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_dashboard_url="custom_dashboard_url_example", dashboard_link_visibility="INTERNAL_ONLY", description="This is a channel", - destination=DeclarativeNotificationChannelDestination(None), + destination=NotificationChannelDestination(), id="notification-channel-1", in_platform_notification="DISABLED", name="channel", @@ -652,7 +653,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeOrganizationPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -686,7 +687,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -704,7 +705,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -755,7 +756,7 @@ with gooddata_api_client.ApiClient() as api_client: automations=[ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -785,15 +786,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -816,11 +809,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -829,13 +818,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -874,6 +864,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -950,20 +941,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -990,6 +974,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -1017,6 +1002,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -1048,6 +1057,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -1061,12 +1073,20 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], ), ], cache_extra_limit=1, + color_palettes=[ + DeclarativeWorkspaceColorPalette( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", @@ -1085,6 +1105,79 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + export_templates=[ + DeclarativeWorkspaceExportTemplate( + dashboard_slides_template=WorkspaceDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WorkspaceWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], filter_views=[ DeclarativeFilterView( analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -1108,7 +1201,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1207,7 +1300,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -1275,7 +1368,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -1321,6 +1414,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -1485,7 +1591,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -1506,7 +1612,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1520,6 +1626,13 @@ with gooddata_api_client.ApiClient() as api_client: type="TIMEZONE", ), ], + themes=[ + DeclarativeWorkspaceTheme( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], user_data_filters=[ DeclarativeUserDataFilter( description="ID of country setting", diff --git a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md index 10eac79c0..76272e600 100644 --- a/gooddata-api-client/docs/OrganizationEntityAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationEntityAPIsApi.md @@ -52,7 +52,7 @@ with gooddata_api_client.ApiClient() as api_client: ip_allowlist_policy_targets = IpAllowlistPolicyTargets( targets=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], @@ -1093,7 +1093,7 @@ with gooddata_api_client.ApiClient() as api_client: ip_allowlist_policy_targets = IpAllowlistPolicyTargets( targets=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], diff --git a/gooddata-api-client/docs/OutlierDetectionRequest.md b/gooddata-api-client/docs/OutlierDetectionRequest.md index 0178600d3..dd2a00343 100644 --- a/gooddata-api-client/docs/OutlierDetectionRequest.md +++ b/gooddata-api-client/docs/OutlierDetectionRequest.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to be used in the computation. | -**filters** | [**[ChangeAnalysisParamsFiltersInner]**](ChangeAnalysisParamsFiltersInner.md) | Various filter types to filter the execution result. | **granularity** | **str** | Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR). | **measures** | [**[MeasureItem]**](MeasureItem.md) | | **sensitivity** | **str** | Sensitivity level for outlier detection | **aux_measures** | [**[MeasureItem]**](MeasureItem.md) | Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result. | [optional] +**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Various filter types to filter the execution result. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/DashboardParameterValue.md b/gooddata-api-client/docs/ParameterValue.md similarity index 97% rename from gooddata-api-client/docs/DashboardParameterValue.md rename to gooddata-api-client/docs/ParameterValue.md index c40cf21eb..8d7bd3181 100644 --- a/gooddata-api-client/docs/DashboardParameterValue.md +++ b/gooddata-api-client/docs/ParameterValue.md @@ -1,4 +1,4 @@ -# DashboardParameterValue +# ParameterValue Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display. diff --git a/gooddata-api-client/docs/PendingOperation.md b/gooddata-api-client/docs/PendingOperation.md index 36fd9644c..5af957237 100644 --- a/gooddata-api-client/docs/PendingOperation.md +++ b/gooddata-api-client/docs/PendingOperation.md @@ -7,7 +7,7 @@ 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | -**status** | **str** | | +**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] [[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/PermissionsApi.md b/gooddata-api-client/docs/PermissionsApi.md index a6effb196..c7599d2c9 100644 --- a/gooddata-api-client/docs/PermissionsApi.md +++ b/gooddata-api-client/docs/PermissionsApi.md @@ -18,8 +18,10 @@ Method | HTTP request | Description [**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_organization_permissions**](PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization [**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 [**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 @@ -796,7 +798,7 @@ with gooddata_api_client.ApiClient() as api_client: data_source_permission_assignment = [ DataSourcePermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), permissions=[ @@ -975,6 +977,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[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) + +# **manage_metric_permissions** +> manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner) + +(BETA) Manage Permissions for a Metric + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +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 = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + metric_id = "metricId_example" # str | + manage_metric_permissions_request_inner = [ + ManageMetricPermissionsRequestInner(None), + ] # [ManageMetricPermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) 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) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **metric_id** | **str**| | + **manage_metric_permissions_request_inner** | [**[ManageMetricPermissionsRequestInner]**](ManageMetricPermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -1013,7 +1085,7 @@ with gooddata_api_client.ApiClient() as api_client: organization_permission_assignment = [ OrganizationPermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), permissions=[ @@ -1090,7 +1162,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_permission_assignment = [ WorkspacePermissionAssignment( assignee_identifier=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), hierarchy_permissions=[ @@ -1140,6 +1212,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) +# **metric_permissions** +> MetricPermissions metric_permissions(workspace_id, metric_id) + +(BETA) Get Metric Permissions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.metric_permissions import MetricPermissions +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 = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + metric_id = "metricId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get Metric Permissions + api_response = api_instance.metric_permissions(workspace_id, metric_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PermissionsApi->metric_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **metric_id** | **str**| | + +### Return type + +[**MetricPermissions**](MetricPermissions.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) + # **set_organization_permissions** > set_organization_permissions(declarative_organization_permission) @@ -1170,7 +1309,7 @@ with gooddata_api_client.ApiClient() as api_client: declarative_organization_permission = [ DeclarativeOrganizationPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1246,7 +1385,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -1324,7 +1463,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -1402,7 +1541,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1411,7 +1550,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", diff --git a/gooddata-api-client/docs/PipeTable.md b/gooddata-api-client/docs/PipeTable.md index 6a3b49efb..4094c65bf 100644 --- a/gooddata-api-client/docs/PipeTable.md +++ b/gooddata-api-client/docs/PipeTable.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **columns** | [**[ColumnInfo]**](ColumnInfo.md) | Inferred column schema | **database_name** | **str** | Database name | -**distribution_config** | [**PipeTableDistributionConfig**](PipeTableDistributionConfig.md) | | -**key_config** | [**PipeTableKeyConfig**](PipeTableKeyConfig.md) | | +**distribution_config** | [**CreatePipeTableRequestDistributionConfig**](CreatePipeTableRequestDistributionConfig.md) | | +**key_config** | [**CreatePipeTableRequestKeyConfig**](CreatePipeTableRequestKeyConfig.md) | | **partition_columns** | **[str]** | Hive partition columns detected from the path structure | **path_prefix** | **str** | Path prefix to the parquet files | **pipe_table_id** | **str** | Internal UUID of the pipe table record | @@ -16,7 +16,7 @@ Name | Type | Description | Notes **source_storage_name** | **str** | Source ObjectStorage name | **table_name** | **str** | OLAP table name | **table_properties** | **{str: (str,)}** | CREATE TABLE PROPERTIES key-value pairs | -**partition_config** | [**PipeTablePartitionConfig**](PipeTablePartitionConfig.md) | | [optional] +**partition_config** | [**CreatePipeTableRequestPartitionConfig**](CreatePipeTableRequestPartitionConfig.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/PrimaryKeyConfig.md b/gooddata-api-client/docs/PrimaryKeyConfig.md index 0bfb09a48..cdbeadb73 100644 --- a/gooddata-api-client/docs/PrimaryKeyConfig.md +++ b/gooddata-api-client/docs/PrimaryKeyConfig.md @@ -5,6 +5,7 @@ Primary key model — enforces uniqueness, replaces on conflict. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "primary" **columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/RandomDistributionConfig.md b/gooddata-api-client/docs/RandomDistributionConfig.md index 1826a3e2c..85320054e 100644 --- a/gooddata-api-client/docs/RandomDistributionConfig.md +++ b/gooddata-api-client/docs/RandomDistributionConfig.md @@ -5,6 +5,7 @@ Random distribution across buckets. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "random" **buckets** | **int** | Number of random distribution buckets. Defaults to 1. | [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/RawExportApi.md b/gooddata-api-client/docs/RawExportApi.md index 1ae5580d8..46f1fe049 100644 --- a/gooddata-api-client/docs/RawExportApi.md +++ b/gooddata-api-client/docs/RawExportApi.md @@ -95,20 +95,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", diff --git a/gooddata-api-client/docs/RichTextWidgetDescriptor.md b/gooddata-api-client/docs/RichTextWidgetDescriptor.md index 2689d820e..aa6a1b4aa 100644 --- a/gooddata-api-client/docs/RichTextWidgetDescriptor.md +++ b/gooddata-api-client/docs/RichTextWidgetDescriptor.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **str** | Widget title as displayed on the dashboard. | **widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | defaults to "richText" **content** | **str** | Markdown/text content of the rich text widget. | [optional] **filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [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/ScheduleCacheRetention.md b/gooddata-api-client/docs/ScheduleCacheRetention.md new file mode 100644 index 000000000..8f8f23383 --- /dev/null +++ b/gooddata-api-client/docs/ScheduleCacheRetention.md @@ -0,0 +1,14 @@ +# ScheduleCacheRetention + +The cache expires according to a schedule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedule** | [**CacheRetentionSchedule**](CacheRetentionSchedule.md) | | +**type** | **str** | The cache retention type. | defaults to "SCHEDULE" +**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/SearchResultObject.md b/gooddata-api-client/docs/SearchResultObject.md index 67eeace04..cb580d3c2 100644 --- a/gooddata-api-client/docs/SearchResultObject.md +++ b/gooddata-api-client/docs/SearchResultObject.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **title** | **str** | Object title. | **type** | **str** | Object type, e.g. dashboard. | **workspace_id** | **str** | Workspace ID. | +**certification** | [**CertificationInfo**](CertificationInfo.md) | | [optional] **created_at** | **datetime** | Timestamp when object was created. | [optional] **description** | **str** | Object description. | [optional] **is_hidden** | **bool** | If true, this object is hidden from AI search results by default. | [optional] diff --git a/gooddata-api-client/docs/SlidesExportApi.md b/gooddata-api-client/docs/SlidesExportApi.md index e6eaa3d66..73c2ba0d7 100644 --- a/gooddata-api-client/docs/SlidesExportApi.md +++ b/gooddata-api-client/docs/SlidesExportApi.md @@ -44,6 +44,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], diff --git a/gooddata-api-client/docs/SlidesExportRequest.md b/gooddata-api-client/docs/SlidesExportRequest.md index 6844f53ac..c3db584c6 100644 --- a/gooddata-api-client/docs/SlidesExportRequest.md +++ b/gooddata-api-client/docs/SlidesExportRequest.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **dashboard_id** | **str** | Dashboard identifier | [optional] **metadata** | [**JsonNode**](JsonNode.md) | | [optional] **template_id** | **str, none_type** | Export template identifier. | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] **visualization_ids** | **[str]** | List of visualization ids to be exported. Note that only one visualization is currently supported. | [optional] **widget_ids** | **[str]** | List of widget identifiers to be exported. Note that only one widget is currently supported. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index 94371a59f..326c027cf 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -14,8 +14,8 @@ Method | HTTP request | Description [**clustering**](SmartFunctionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering [**clustering_result**](SmartFunctionsApi.md#clustering_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId} | (EXPERIMENTAL) Smart functions - Clustering Result [**created_by**](SmartFunctionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users -[**forecast**](SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | (BETA) Smart functions - Forecast -[**forecast_result**](SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | (BETA) Smart functions - Forecast Result +[**forecast**](SmartFunctionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast +[**forecast_result**](SmartFunctionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result [**generate_description**](SmartFunctionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object [**generate_title**](SmartFunctionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object [**get_quality_issues**](SmartFunctionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues @@ -109,7 +109,7 @@ with gooddata_api_client.ApiClient() as api_client: widgets=[ WidgetDescriptor( filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], title="title_example", widget_id="widget_id_example", @@ -315,7 +315,7 @@ with gooddata_api_client.ApiClient() as api_client: widgets=[ WidgetDescriptor( filters=[ - ChangeAnalysisParamsFiltersInner(None), + FilterDefinition(), ], title="title_example", widget_id="widget_id_example", @@ -889,7 +889,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + workspace_id = "workspaceId_example" # str | # example passing only required values which don't have defaults set try: @@ -905,7 +905,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| | ### Return type @@ -932,9 +932,9 @@ No authorization required # **forecast** > SmartFunctionResponse forecast(workspace_id, result_id, forecast_request) -(BETA) Smart functions - Forecast +Smart functions - Forecast -(BETA) Computes forecasted data points from the provided execution result and parameters. +Computes forecasted data points from the provided execution result and parameters. ### Example @@ -968,7 +968,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Smart functions - Forecast + # Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -977,7 +977,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) Smart functions - Forecast + # Smart functions - Forecast api_response = api_instance.forecast(workspace_id, result_id, forecast_request, skip_cache=skip_cache) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1019,9 +1019,9 @@ No authorization required # **forecast_result** > ForecastResult forecast_result(workspace_id, result_id) -(BETA) Smart functions - Forecast Result +Smart functions - Forecast Result -(BETA) Gets forecast result. +Gets forecast result. ### Example @@ -1050,7 +1050,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Smart functions - Forecast Result + # Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1059,7 +1059,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) Smart functions - Forecast Result + # Smart functions - Forecast Result api_response = api_instance.forecast_result(workspace_id, result_id, offset=offset, limit=limit) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -1409,7 +1409,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) list_llm_provider_models_request = ListLlmProviderModelsRequest( - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # ListLlmProviderModelsRequest | # example passing only required values which don't have defaults set @@ -1743,7 +1743,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + workspace_id = "workspaceId_example" # str | # example passing only required values which don't have defaults set try: @@ -1759,7 +1759,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **workspace_id** | **str**| | ### Return type @@ -1818,7 +1818,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # TestLlmProviderDefinitionRequest | # example passing only required values which don't have defaults set @@ -1895,7 +1895,7 @@ with gooddata_api_client.ApiClient() as api_client: id="id_example", ), ], - provider_config=ListLlmProviderModelsRequestProviderConfig(None), + provider_config=LlmProviderConfig(None), ) # TestLlmProviderByIdRequest | (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/StringConstraints.md b/gooddata-api-client/docs/StringConstraints.md index 65bcfa0a2..5850618f1 100644 --- a/gooddata-api-client/docs/StringConstraints.md +++ b/gooddata-api-client/docs/StringConstraints.md @@ -4,6 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**allowed_values** | [**[StringParameterAllowedValue]**](StringParameterAllowedValue.md) | | [optional] **max_length** | **int** | | [optional] **min_length** | **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] diff --git a/gooddata-api-client/docs/LlmProviderAuth.md b/gooddata-api-client/docs/StringParameterAllowedValue.md similarity index 82% rename from gooddata-api-client/docs/LlmProviderAuth.md rename to gooddata-api-client/docs/StringParameterAllowedValue.md index 814d9fd14..1d4d6e15f 100644 --- a/gooddata-api-client/docs/LlmProviderAuth.md +++ b/gooddata-api-client/docs/StringParameterAllowedValue.md @@ -1,10 +1,11 @@ -# LlmProviderAuth +# StringParameterAllowedValue ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | +**value** | **str** | | +**title** | **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/SucceededOperation.md b/gooddata-api-client/docs/SucceededOperation.md index fddf0864d..8b88eb844 100644 --- a/gooddata-api-client/docs/SucceededOperation.md +++ b/gooddata-api-client/docs/SucceededOperation.md @@ -7,7 +7,7 @@ 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | -**status** | **str** | | +**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/TabularExportApi.md b/gooddata-api-client/docs/TabularExportApi.md index f40a97dcd..f26b26c49 100644 --- a/gooddata-api-client/docs/TabularExportApi.md +++ b/gooddata-api-client/docs/TabularExportApi.md @@ -44,11 +44,7 @@ with gooddata_api_client.ApiClient() as api_client: DashboardFilter(), ], dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -57,13 +53,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -161,6 +158,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -192,6 +213,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ) # TabularExportRequest | # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/TabularExportExecution.md b/gooddata-api-client/docs/TabularExportExecution.md new file mode 100644 index 000000000..3130c6871 --- /dev/null +++ b/gooddata-api-client/docs/TabularExportExecution.md @@ -0,0 +1,15 @@ +# TabularExportExecution + +A single pre-executed layer in a multi-layer tabular export. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_result** | **str** | Execution result identifier for this layer. | +**custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] +**title** | **str** | Layer title used for the exported sheet or file name. | [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/TabularExportRequest.md b/gooddata-api-client/docs/TabularExportRequest.md index 55026f1e5..e3a3c6e8f 100644 --- a/gooddata-api-client/docs/TabularExportRequest.md +++ b/gooddata-api-client/docs/TabularExportRequest.md @@ -9,11 +9,14 @@ Name | Type | Description | Notes **format** | **str** | Expected file format. | **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] +**execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**executions** | [**[TabularExportExecution]**](TabularExportExecution.md) | Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride. | [optional] **metadata** | [**JsonNode**](JsonNode.md) | | [optional] **related_dashboard_id** | **str** | Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard. | [optional] **settings** | [**Settings**](Settings.md) | | [optional] **visualization_object** | **str** | Visualization object identifier. Alternative to executionResult property. | [optional] **visualization_object_custom_filters** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization. | [optional] +**visualization_object_custom_parameters** | [**[ParameterValue]**](ParameterValue.md) | Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization. | [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/TestConnectionApi.md b/gooddata-api-client/docs/TestConnectionApi.md index 9fcfab0b5..e5e16d09a 100644 --- a/gooddata-api-client/docs/TestConnectionApi.md +++ b/gooddata-api-client/docs/TestConnectionApi.md @@ -38,6 +38,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = test_connection_api.TestConnectionApi(api_client) data_source_id = "myPostgres" # str | Data source id test_request = TestRequest( + authentication_type="USERNAME_PASSWORD", client_id="client_id_example", client_secret="client_secret_example", parameters=[ @@ -123,6 +124,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = test_connection_api.TestConnectionApi(api_client) test_definition_request = TestDefinitionRequest( + authentication_type="USERNAME_PASSWORD", client_id="client_id_example", client_secret="client_secret_example", parameters=[ diff --git a/gooddata-api-client/docs/TestDefinitionRequest.md b/gooddata-api-client/docs/TestDefinitionRequest.md index dea6137b3..4431efe40 100644 --- a/gooddata-api-client/docs/TestDefinitionRequest.md +++ b/gooddata-api-client/docs/TestDefinitionRequest.md @@ -6,6 +6,7 @@ A request containing all information for testing data source definition. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | Type of database, where test should connect to. | +**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH). | [optional] **client_id** | **str** | Id for client based authentication for data sources which supports it. | [optional] **client_secret** | **str** | Secret for client based authentication for data sources which supports it. | [optional] **parameters** | [**[DataSourceParameter]**](DataSourceParameter.md) | | [optional] diff --git a/gooddata-api-client/docs/TestDestinationRequest.md b/gooddata-api-client/docs/TestDestinationRequest.md index 16fd8e55d..6451c0e2f 100644 --- a/gooddata-api-client/docs/TestDestinationRequest.md +++ b/gooddata-api-client/docs/TestDestinationRequest.md @@ -5,7 +5,7 @@ Request body with notification channel destination to test. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**destination** | [**DeclarativeNotificationChannelDestination**](DeclarativeNotificationChannelDestination.md) | | +**destination** | [**NotificationChannelDestination**](NotificationChannelDestination.md) | | **external_recipients** | [**[AutomationExternalRecipient], none_type**](AutomationExternalRecipient.md) | External recipients of the test result. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/TestLlmProviderByIdRequest.md b/gooddata-api-client/docs/TestLlmProviderByIdRequest.md index a4b9e4929..b772cd11d 100644 --- a/gooddata-api-client/docs/TestLlmProviderByIdRequest.md +++ b/gooddata-api-client/docs/TestLlmProviderByIdRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **models** | [**[LlmModel]**](LlmModel.md) | Models overrides. | [optional] -**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | [optional] +**provider_config** | [**LlmProviderConfig**](LlmProviderConfig.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/TestLlmProviderDefinitionRequest.md b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md index 809a7d1df..52d57e74c 100644 --- a/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md +++ b/gooddata-api-client/docs/TestLlmProviderDefinitionRequest.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**provider_config** | [**ListLlmProviderModelsRequestProviderConfig**](ListLlmProviderModelsRequestProviderConfig.md) | | +**provider_config** | [**LlmProviderConfig**](LlmProviderConfig.md) | | **models** | [**[LlmModel]**](LlmModel.md) | Models to test. | [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/TestNotification.md b/gooddata-api-client/docs/TestNotification.md index de23cc1fd..dc69c124e 100644 --- a/gooddata-api-client/docs/TestNotification.md +++ b/gooddata-api-client/docs/TestNotification.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | | -**type** | **str** | | +**type** | **str** | | defaults to "TEST" **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/TestRequest.md b/gooddata-api-client/docs/TestRequest.md index c79efb371..3f1380676 100644 --- a/gooddata-api-client/docs/TestRequest.md +++ b/gooddata-api-client/docs/TestRequest.md @@ -5,6 +5,7 @@ A request containing all information for testing existing data source. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**authentication_type** | **str, none_type** | Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH). | [optional] **client_id** | **str** | Id for client based authentication for data sources which supports it. | [optional] **client_secret** | **str** | Secret for client based authentication for data sources which supports it. | [optional] **parameters** | [**[DataSourceParameter]**](DataSourceParameter.md) | | [optional] diff --git a/gooddata-api-client/docs/TimeSlicePartitionConfig.md b/gooddata-api-client/docs/TimeSlicePartitionConfig.md index af08c33a0..2f925a2fe 100644 --- a/gooddata-api-client/docs/TimeSlicePartitionConfig.md +++ b/gooddata-api-client/docs/TimeSlicePartitionConfig.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **column** | **str** | Column to partition on. | **slices** | **int** | How many units per slice. | **unit** | **str** | Date/time unit for partition granularity | +**type** | **str** | | defaults to "timeSlice" **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/UniqueKeyConfig.md b/gooddata-api-client/docs/UniqueKeyConfig.md index f1f2a058e..b78513aa0 100644 --- a/gooddata-api-client/docs/UniqueKeyConfig.md +++ b/gooddata-api-client/docs/UniqueKeyConfig.md @@ -5,6 +5,7 @@ Unique key model — enforces uniqueness, replaces on conflict. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "unique" **columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md b/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md index 2a7860839..b67fd82cc 100644 --- a/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/UserGroupsDeclarativeAPIsApi.md @@ -177,7 +177,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -265,7 +265,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserGroupPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", @@ -283,7 +283,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", diff --git a/gooddata-api-client/docs/UserManagementApi.md b/gooddata-api-client/docs/UserManagementApi.md index e8ea3cb5c..b81b7ee2f 100644 --- a/gooddata-api-client/docs/UserManagementApi.md +++ b/gooddata-api-client/docs/UserManagementApi.md @@ -119,7 +119,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions_assignment = PermissionsAssignment( assignees=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], @@ -270,6 +270,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = user_management_api.UserManagementApi(api_client) user_id = "userId_example" # str | + include_inherited = True # bool | When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only). (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -277,6 +278,14 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling UserManagementApi->list_permissions_for_user: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_permissions_for_user(user_id, include_inherited=include_inherited) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_permissions_for_user: %s\n" % e) ``` @@ -285,6 +294,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | + **include_inherited** | **bool**| When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only). | [optional] if omitted the server will use the default value of False ### Return type @@ -334,6 +344,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = user_management_api.UserManagementApi(api_client) user_group_id = "userGroupId_example" # str | + include_inherited = True # bool | When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only). (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: @@ -341,6 +352,14 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling UserManagementApi->list_permissions_for_user_group: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + api_response = api_instance.list_permissions_for_user_group(user_group_id, include_inherited=include_inherited) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserManagementApi->list_permissions_for_user_group: %s\n" % e) ``` @@ -349,6 +368,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_group_id** | **str**| | + **include_inherited** | **bool**| When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only). | [optional] if omitted the server will use the default value of False ### Return type @@ -626,7 +646,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | page = page=0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = size=20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 - name = "name=charles" # str | Filter by user name. Note that user name is case insensitive. (optional) + name = "name=charles" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) # example passing only required values which don't have defaults set try: @@ -652,7 +672,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **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 - **name** | **str**| Filter by user name. Note that user name is case insensitive. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] ### Return type @@ -944,7 +964,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = user_management_api.UserManagementApi(api_client) assignee_identifier = [ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ] # [AssigneeIdentifier] | @@ -1013,7 +1033,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions_assignment = PermissionsAssignment( assignees=[ AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), ], diff --git a/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md b/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md index ce6dd671b..f03ebd4c7 100644 --- a/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md +++ b/gooddata-api-client/docs/UserManagementDataSourcePermissionAssignment.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the datasource | **permissions** | **[str]** | | +**access_source** | **str** | How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings. | [optional] [readonly] **name** | **str** | Name of the datasource | [optional] [readonly] **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/UserManagementWorkspacePermissionAssignment.md b/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md index 829a60d93..f477d96d2 100644 --- a/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md +++ b/gooddata-api-client/docs/UserManagementWorkspacePermissionAssignment.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **hierarchy_permissions** | **[str]** | | **id** | **str** | | **permissions** | **[str]** | | +**access_source** | **str** | How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings. | [optional] [readonly] **name** | **str** | | [optional] [readonly] **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/UsersDeclarativeAPIsApi.md b/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md index 54acf3fe5..47eaebaf2 100644 --- a/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/UsersDeclarativeAPIsApi.md @@ -109,7 +109,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeUserPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="SEE", diff --git a/gooddata-api-client/docs/ValidityPeriodCacheRetention.md b/gooddata-api-client/docs/ValidityPeriodCacheRetention.md new file mode 100644 index 000000000..2cece18b7 --- /dev/null +++ b/gooddata-api-client/docs/ValidityPeriodCacheRetention.md @@ -0,0 +1,14 @@ +# ValidityPeriodCacheRetention + +The cache expires once a fixed period elapses since the results were computed. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**validity_period** | **str** | How long the cached results stay valid after they were computed. | +**type** | **str** | The cache retention type. | defaults to "VALIDITY_PERIOD" +**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/VisualExportApi.md b/gooddata-api-client/docs/VisualExportApi.md index 68735513a..80a7b8f88 100644 --- a/gooddata-api-client/docs/VisualExportApi.md +++ b/gooddata-api-client/docs/VisualExportApi.md @@ -42,6 +42,7 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ) # VisualExportRequest | x_gdc_debug = False # bool | (optional) if omitted the server will use the default value of False diff --git a/gooddata-api-client/docs/VisualExportRequest.md b/gooddata-api-client/docs/VisualExportRequest.md index 1d3c4dda1..322b75838 100644 --- a/gooddata-api-client/docs/VisualExportRequest.md +++ b/gooddata-api-client/docs/VisualExportRequest.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **dashboard_id** | **str** | Dashboard identifier | **file_name** | **str** | File name to be used for retrieving the pdf document. | **metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Metadata definition in free-form JSON format. | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[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/VisualizationSwitcherWidgetDescriptor.md b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md index cbf737fca..ce757fd6f 100644 --- a/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md +++ b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **title** | **str** | Widget title as displayed on the dashboard. | **visualization_ids** | **[str]** | IDs of all visualizations available in the switcher. | **widget_id** | **str** | Widget object ID. | +**widget_type** | **str** | | defaults to "visualizationSwitcher" **filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [optional] **result_id** | **str** | Signed result ID for the currently active visualization's execution result. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/WebhookMessageData.md b/gooddata-api-client/docs/WebhookMessageData.md index 1c2a792f0..4d36ede05 100644 --- a/gooddata-api-client/docs/WebhookMessageData.md +++ b/gooddata-api-client/docs/WebhookMessageData.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **filters** | [**[NotificationFilter]**](NotificationFilter.md) | | [optional] **image_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] **notification_source** | **str** | | [optional] +**parameters** | [**[NotificationParameter]**](NotificationParameter.md) | | [optional] **raw_exports** | [**[ExportResult]**](ExportResult.md) | | [optional] **recipients** | [**[WebhookRecipient]**](WebhookRecipient.md) | | [optional] **remaining_action_count** | **int** | | [optional] diff --git a/gooddata-api-client/docs/WidgetDescriptor.md b/gooddata-api-client/docs/WidgetDescriptor.md index 8ece5c571..1f9dc9950 100644 --- a/gooddata-api-client/docs/WidgetDescriptor.md +++ b/gooddata-api-client/docs/WidgetDescriptor.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **title** | **str** | | **widget_id** | **str** | | **widget_type** | **str** | | -**filters** | [**[ChangeAnalysisParamsFiltersInner]**](ChangeAnalysisParamsFiltersInner.md) | | [optional] +**filters** | [**[FilterDefinition]**](FilterDefinition.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/WorkspaceColorPaletteControllerApi.md b/gooddata-api-client/docs/WorkspaceColorPaletteControllerApi.md new file mode 100644 index 000000000..b07cf09c8 --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceColorPaletteControllerApi.md @@ -0,0 +1,525 @@ +# gooddata_api_client.WorkspaceColorPaletteControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#create_entity_workspace_color_palettes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Post Workspace Color Palette +[**delete_entity_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#delete_entity_workspace_color_palettes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Delete a Workspace Color Palette +[**get_all_entities_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#get_all_entities_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes | Get all Workspace Color Palettes +[**get_entity_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#get_entity_workspace_color_palettes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Get a Workspace Color Palette +[**patch_entity_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#patch_entity_workspace_color_palettes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Patch a Workspace Color Palette +[**update_entity_workspace_color_palettes**](WorkspaceColorPaletteControllerApi.md#update_entity_workspace_color_palettes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId} | Put a Workspace Color Palette + + +# **create_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + +Post Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPaletteInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->create_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->create_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **delete_entity_workspace_color_palettes** +> delete_entity_workspace_color_palettes(workspace_id, object_id) + +Delete a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Color Palette + api_instance.delete_entity_workspace_color_palettes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->delete_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutList get_all_entities_workspace_color_palettes(workspace_id) + +Get all Workspace Color Palettes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->get_all_entities_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->get_all_entities_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutList**](JsonApiWorkspaceColorPaletteOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument get_entity_workspace_color_palettes(workspace_id, object_id) + +Get a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->get_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->get_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **patch_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) + +Patch a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument +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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_color_palette_patch_document = JsonApiWorkspaceColorPalettePatchDocument( + data=JsonApiWorkspaceColorPalettePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPalettePatchDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->patch_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Color Palette + api_response = api_instance.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->patch_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_color_palette_patch_document** | [**JsonApiWorkspaceColorPalettePatchDocument**](JsonApiWorkspaceColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **update_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) + +Put a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_color_palette_controller_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +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 = workspace_color_palette_controller_api.WorkspaceColorPaletteControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceColorPalette", + ), + ) # JsonApiWorkspaceColorPaletteInDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->update_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Color Palette + api_response = api_instance.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceColorPaletteControllerApi->update_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + diff --git a/gooddata-api-client/docs/WorkspaceDashboardSlidesTemplate.md b/gooddata-api-client/docs/WorkspaceDashboardSlidesTemplate.md new file mode 100644 index 000000000..27ce76e5e --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceDashboardSlidesTemplate.md @@ -0,0 +1,17 @@ +# WorkspaceDashboardSlidesTemplate + +Template for workspace dashboard slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.md) | | [optional] +**cover_slide** | [**CoverSlideTemplate**](CoverSlideTemplate.md) | | [optional] +**intro_slide** | [**IntroSlideTemplate**](IntroSlideTemplate.md) | | [optional] +**section_slide** | [**SectionSlideTemplate**](SectionSlideTemplate.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/WorkspaceExportTemplateControllerApi.md b/gooddata-api-client/docs/WorkspaceExportTemplateControllerApi.md new file mode 100644 index 000000000..f52945093 --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceExportTemplateControllerApi.md @@ -0,0 +1,723 @@ +# gooddata_api_client.WorkspaceExportTemplateControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#create_entity_workspace_export_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Post Workspace Export Template +[**delete_entity_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#delete_entity_workspace_export_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Delete a Workspace Export Template +[**get_all_entities_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#get_all_entities_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates | Get all Workspace Export Templates +[**get_entity_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#get_entity_workspace_export_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Get a Workspace Export Template +[**patch_entity_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#patch_entity_workspace_export_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Patch a Workspace Export Template +[**update_entity_workspace_export_templates**](WorkspaceExportTemplateControllerApi.md#update_entity_workspace_export_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId} | Put a Workspace Export Template + + +# **create_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) + +Post Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_api +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_export_template_post_optional_id_document = JsonApiWorkspaceExportTemplatePostOptionalIdDocument( + data=JsonApiWorkspaceExportTemplatePostOptionalId( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplatePostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->create_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->create_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_export_template_post_optional_id_document** | [**JsonApiWorkspaceExportTemplatePostOptionalIdDocument**](JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **delete_entity_workspace_export_templates** +> delete_entity_workspace_export_templates(workspace_id, object_id) + +Delete a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Export Template + api_instance.delete_entity_workspace_export_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->delete_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutList get_all_entities_workspace_export_templates(workspace_id) + +Get all Workspace Export Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_api +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->get_all_entities_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->get_all_entities_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutList**](JsonApiWorkspaceExportTemplateOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument get_entity_workspace_export_templates(workspace_id, object_id) + +Get a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_api +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->get_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->get_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **patch_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) + +Patch a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_api +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_export_template_patch_document = JsonApiWorkspaceExportTemplatePatchDocument( + data=JsonApiWorkspaceExportTemplatePatch( + attributes=JsonApiWorkspaceExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplatePatchDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->patch_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Export Template + api_response = api_instance.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->patch_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_patch_document** | [**JsonApiWorkspaceExportTemplatePatchDocument**](JsonApiWorkspaceExportTemplatePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **update_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) + +Put a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_export_template_controller_api +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +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 = workspace_export_template_controller_api.WorkspaceExportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_export_template_in_document = JsonApiWorkspaceExportTemplateInDocument( + data=JsonApiWorkspaceExportTemplateIn( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + name="name_example", + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + id="id1", + type="workspaceExportTemplate", + ), + ) # JsonApiWorkspaceExportTemplateInDocument | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->update_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Export Template + api_response = api_instance.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceExportTemplateControllerApi->update_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_export_template_in_document** | [**JsonApiWorkspaceExportTemplateInDocument**](JsonApiWorkspaceExportTemplateInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + diff --git a/gooddata-api-client/docs/WorkspaceThemeControllerApi.md b/gooddata-api-client/docs/WorkspaceThemeControllerApi.md new file mode 100644 index 000000000..35e014a8c --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceThemeControllerApi.md @@ -0,0 +1,525 @@ +# gooddata_api_client.WorkspaceThemeControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_workspace_themes**](WorkspaceThemeControllerApi.md#create_entity_workspace_themes) | **POST** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Post Workspace Theme +[**delete_entity_workspace_themes**](WorkspaceThemeControllerApi.md#delete_entity_workspace_themes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Delete a Workspace Theme +[**get_all_entities_workspace_themes**](WorkspaceThemeControllerApi.md#get_all_entities_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes | Get all Workspace Themes +[**get_entity_workspace_themes**](WorkspaceThemeControllerApi.md#get_entity_workspace_themes) | **GET** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Get a Workspace Theme +[**patch_entity_workspace_themes**](WorkspaceThemeControllerApi.md#patch_entity_workspace_themes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Patch a Workspace Theme +[**update_entity_workspace_themes**](WorkspaceThemeControllerApi.md#update_entity_workspace_themes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId} | Put a Workspace Theme + + +# **create_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + +Post Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->create_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->create_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | 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) + +# **delete_entity_workspace_themes** +> delete_entity_workspace_themes(workspace_id, object_id) + +Delete a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Delete a Workspace Theme + api_instance.delete_entity_workspace_themes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->delete_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_workspace_themes** +> JsonApiWorkspaceThemeOutList get_all_entities_workspace_themes(workspace_id) + +Get all Workspace Themes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_api +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (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 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->get_all_entities_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->get_all_entities_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [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 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutList**](JsonApiWorkspaceThemeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **get_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument get_entity_workspace_themes(workspace_id, object_id) + +Get a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->get_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->get_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **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) + +# **patch_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) + +Patch a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument +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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_theme_patch_document = JsonApiWorkspaceThemePatchDocument( + data=JsonApiWorkspaceThemePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemePatchDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->patch_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Workspace Theme + api_response = api_instance.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->patch_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_theme_patch_document** | [**JsonApiWorkspaceThemePatchDocument**](JsonApiWorkspaceThemePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + +# **update_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) + +Put a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import workspace_theme_controller_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +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 = workspace_theme_controller_api.WorkspaceThemeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->update_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Workspace Theme + api_response = api_instance.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling WorkspaceThemeControllerApi->update_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **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) + diff --git a/gooddata-api-client/docs/WorkspaceWidgetSlidesTemplate.md b/gooddata-api-client/docs/WorkspaceWidgetSlidesTemplate.md new file mode 100644 index 000000000..a391a732e --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceWidgetSlidesTemplate.md @@ -0,0 +1,14 @@ +# WorkspaceWidgetSlidesTemplate + +Template for workspace widget slides export. Available variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}} + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applied_on** | **[str]** | Export types this template applies to. | +**content_slide** | [**ContentSlideTemplate**](ContentSlideTemplate.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/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index 3f632bd76..c92fb0ba0 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -280,7 +280,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -348,7 +348,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -394,6 +394,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -558,7 +571,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -667,7 +680,7 @@ with gooddata_api_client.ApiClient() as api_client: automations=[ DeclarativeAutomation( alert=AutomationAlert( - condition=AutomationAlertCondition(None), + condition=AlertCondition(), execution=AlertAfm( attributes=[ AttributeItem( @@ -697,15 +710,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), interval="DAY", @@ -728,11 +733,7 @@ with gooddata_api_client.ApiClient() as api_client: ], dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", dashboard_parameters_override=[ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], dashboard_tabs_filters_overrides={ "key": [ @@ -741,13 +742,14 @@ with gooddata_api_client.ApiClient() as api_client: }, dashboard_tabs_parameters_overrides={ "key": [ - DashboardParameterValue( - id="year", - title="Year", - value="2026", - ), + ParameterValue(), ], }, + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), file_name="result", format="XLSX", settings=DashboardExportSettings( @@ -786,6 +788,7 @@ with gooddata_api_client.ApiClient() as api_client: file_name="filename", format="PNG", metadata=JsonNode(), + timezone_id="Asia/Kolkata", widget_ids=[ "widget_ids_example", ], @@ -862,20 +865,13 @@ with gooddata_api_client.ApiClient() as api_client: ), ], parameters=[ - ParameterItem( - parameter=AfmObjectIdentifierParameter( - identifier=AfmObjectIdentifierParameterIdentifier( - id="sample_item.price", - type="parameter", - ), - ), - value="value_example", - ), + ParameterItem(), ], ), execution_settings=ExecutionSettings( data_sampling_percentage=0, timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", ), file_name="result", format="CSV", @@ -902,6 +898,7 @@ with gooddata_api_client.ApiClient() as api_client: format="PDF", metadata=JsonNode(), template_id="template_id_example", + timezone_id="Asia/Kolkata", visualization_ids=[ "visualization_ids_example", ], @@ -929,6 +926,30 @@ with gooddata_api_client.ApiClient() as api_client: }, ), execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], file_name="result", format="CSV", metadata=JsonNode(), @@ -960,6 +981,9 @@ with gooddata_api_client.ApiClient() as api_client: visualization_object_custom_filters=[ {}, ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], ), ), ], @@ -973,12 +997,20 @@ with gooddata_api_client.ApiClient() as api_client: dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", metadata={}, + timezone_id="Asia/Kolkata", ), ), ], ), ], cache_extra_limit=1, + color_palettes=[ + DeclarativeWorkspaceColorPalette( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", @@ -997,6 +1029,79 @@ with gooddata_api_client.ApiClient() as api_client: early_access_values=[ "early_access_values_example", ], + export_templates=[ + DeclarativeWorkspaceExportTemplate( + dashboard_slides_template=WorkspaceDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + id="default-export-template", + name="My default export template", + widget_slides_template=WorkspaceWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), + ), + ], filter_views=[ DeclarativeFilterView( analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -1020,7 +1125,7 @@ with gooddata_api_client.ApiClient() as api_client: hierarchy_permissions=[ DeclarativeWorkspaceHierarchyPermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1119,7 +1224,7 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), - request_payload=DeclarativeExportDefinitionRequestPayload(None), + request_payload=ExportRequest(), tags=["Revenues"], title="My regular export", ), @@ -1187,7 +1292,7 @@ with gooddata_api_client.ApiClient() as api_client: ], parameters=[ DeclarativeParameter( - content=DeclarativeParameterContent(None), + content=ParameterDefinition(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( id="employee123", @@ -1233,6 +1338,19 @@ with gooddata_api_client.ApiClient() as api_client: ], ), ldm=DeclarativeLdm( + calendars={ + "key": DeclarativeCalendar( + definition=CalendarDefinition(), + description="Custom fiscal calendar starting in April.", + enabled_granularities=[ + CalendarGranularity( + granularity="FISCAL_MONTH", + prefix="FP", + ), + ], + name="Fiscal calendar", + ), + }, dataset_extensions=[ DeclarativeDatasetExtension( id="customers", @@ -1397,7 +1515,7 @@ with gooddata_api_client.ApiClient() as api_client: DeclarativeDateDataset( description="A customer order date", granularities=[ - "MINUTE", + "SECOND", ], granularities_formatting=GranularitiesFormatting( title_base="title_base_example", @@ -1418,7 +1536,7 @@ with gooddata_api_client.ApiClient() as api_client: permissions=[ DeclarativeSingleWorkspacePermission( assignee=AssigneeIdentifier( - id="id_example", + id="/6bUUGjjNSwg0_bs", type="user", ), name="MANAGE", @@ -1432,6 +1550,13 @@ with gooddata_api_client.ApiClient() as api_client: type="TIMEZONE", ), ], + themes=[ + DeclarativeWorkspaceTheme( + content=JsonNode(), + id="id_example", + name="name_example", + ), + ], user_data_filters=[ DeclarativeUserDataFilter( description="ID of country setting", diff --git a/gooddata-api-client/docs/Xliff.md b/gooddata-api-client/docs/Xliff.md index 6bfea0d90..6bdde8c9a 100644 --- a/gooddata-api-client/docs/Xliff.md +++ b/gooddata-api-client/docs/Xliff.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file** | [**[File]**](File.md) | | [optional] +**file** | [**[File]**](File.md) | | **other_attributes** | **{str: (str,)}** | | [optional] **space** | **str** | | [optional] **src_lang** | **str** | | [optional] 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 c40e4d6b1..ccc1d6b26 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -92,7 +92,9 @@ from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers +from gooddata_api_client.model.metric_permissions import MetricPermissions from gooddata_api_client.model.notifications import Notifications from gooddata_api_client.model.organization_automation_management_bulk_request import OrganizationAutomationManagementBulkRequest from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment @@ -2256,17 +2258,10 @@ def __init__(self, api_client=None): 'enum': [ ], 'validation': [ - 'workspace_id', ] }, root_map={ 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, @@ -4987,6 +4982,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.manage_metric_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions', + 'operation_id': 'manage_metric_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'metric_id', + 'manage_metric_permissions_request_inner', + ], + 'required': [ + 'workspace_id', + 'metric_id', + 'manage_metric_permissions_request_inner', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'metric_id': + (str,), + 'manage_metric_permissions_request_inner': + ([ManageMetricPermissionsRequestInner],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'metric_id': 'metricId', + }, + 'location_map': { + 'workspace_id': 'path', + 'metric_id': 'path', + 'manage_metric_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.manage_organization_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -5237,21 +5292,23 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.metadata_sync_endpoint = _Endpoint( + self.metric_permissions_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (MetricPermissions,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions', + 'operation_id': 'metric_permissions', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', + 'metric_id', ], 'required': [ 'workspace_id', + 'metric_id', ], 'nullable': [ ], @@ -5268,58 +5325,24 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), + 'metric_id': + (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'metric_id': 'metricId', }, 'location_map': { 'workspace_id': 'path', + 'metric_id': 'path', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.metadata_sync_organization_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ + 'accept': [ + 'application/json' ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], 'content_type': [], }, api_client=api_client @@ -5815,6 +5838,46 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.reload_observability_layout_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/reloadObservabilityLayout', + 'operation_id': 'reload_observability_layout', + 'http_method': 'POST', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) self.remove_targets_endpoint = _Endpoint( settings={ 'response_type': None, @@ -6854,17 +6917,10 @@ def __init__(self, api_client=None): 'enum': [ ], 'validation': [ - 'workspace_id', ] }, root_map={ 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, @@ -10944,7 +11000,7 @@ def created_by( >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + workspace_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -11617,9 +11673,9 @@ def forecast( forecast_request, **kwargs ): - """(BETA) Smart functions - Forecast # noqa: E501 + """Smart functions - Forecast # noqa: E501 - (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 + Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -11708,9 +11764,9 @@ def forecast_result( result_id, **kwargs ): - """(BETA) Smart functions - Forecast Result # noqa: E501 + """Smart functions - Forecast Result # noqa: E501 - (BETA) Gets forecast result. # noqa: E501 + Gets forecast result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14465,7 +14521,7 @@ def list_workspace_users( Keyword Args: 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 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [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 @@ -14978,22 +15034,25 @@ def manage_label_permissions( manage_attribute_permissions_request_inner return self.manage_label_permissions_endpoint.call_with_http_info(**kwargs) - def manage_organization_permissions( + def manage_metric_permissions( self, - organization_permission_assignment, + workspace_id, + metric_id, + manage_metric_permissions_request_inner, **kwargs ): - """Manage Permissions for a Organization # noqa: E501 + """(BETA) Manage Permissions for a Metric # noqa: E501 - Manage Permissions for a 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.manage_organization_permissions(organization_permission_assignment, async_req=True) + >>> thread = api.manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner, async_req=True) >>> result = thread.get() Args: - organization_permission_assignment ([OrganizationPermissionAssignment]): + workspace_id (str): + metric_id (str): + manage_metric_permissions_request_inner ([ManageMetricPermissionsRequestInner]): Keyword Args: _return_http_data_only (bool): response data without head status @@ -15057,28 +15116,30 @@ def manage_organization_permissions( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['organization_permission_assignment'] = \ - organization_permission_assignment - return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['metric_id'] = \ + metric_id + kwargs['manage_metric_permissions_request_inner'] = \ + manage_metric_permissions_request_inner + return self.manage_metric_permissions_endpoint.call_with_http_info(**kwargs) - def manage_workspace_permissions( + def manage_organization_permissions( self, - workspace_id, - workspace_permission_assignment, + organization_permission_assignment, **kwargs ): - """Manage Permissions for a Workspace # noqa: E501 + """Manage Permissions for a Organization # noqa: E501 - Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 + Manage Permissions for a 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.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) + >>> thread = api.manage_organization_permissions(organization_permission_assignment, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - workspace_permission_assignment ([WorkspacePermissionAssignment]): + organization_permission_assignment ([OrganizationPermissionAssignment]): Keyword Args: _return_http_data_only (bool): response data without head status @@ -15142,28 +15203,28 @@ def manage_workspace_permissions( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['workspace_permission_assignment'] = \ - workspace_permission_assignment - return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) + kwargs['organization_permission_assignment'] = \ + organization_permission_assignment + return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) - def mark_as_read_notification( + def manage_workspace_permissions( self, - notification_id, + workspace_id, + workspace_permission_assignment, **kwargs ): - """Mark notification as read. # noqa: E501 + """Manage Permissions for a Workspace # noqa: E501 - Mark in-platform notification by its ID as read. # noqa: E501 + Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.mark_as_read_notification(notification_id, async_req=True) + >>> thread = api.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) >>> result = thread.get() Args: - notification_id (str): Notification ID to mark as read. + workspace_id (str): + workspace_permission_assignment ([WorkspacePermissionAssignment]): Keyword Args: _return_http_data_only (bool): response data without head status @@ -15227,26 +15288,30 @@ def mark_as_read_notification( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['notification_id'] = \ - notification_id - return self.mark_as_read_notification_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['workspace_permission_assignment'] = \ + workspace_permission_assignment + return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) - def mark_as_read_notification_all( + def mark_as_read_notification( self, + notification_id, **kwargs ): - """Mark all notifications as read. # noqa: E501 + """Mark notification as read. # noqa: E501 - Mark all user in-platform notifications as read. # noqa: E501 + Mark in-platform notification by its ID as read. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.mark_as_read_notification_all(async_req=True) + >>> thread = api.mark_as_read_notification(notification_id, async_req=True) >>> result = thread.get() + Args: + notification_id (str): Notification ID to mark as read. Keyword Args: - workspace_id (str): Workspace ID where to mark notifications as read.. [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 @@ -15308,26 +15373,26 @@ def mark_as_read_notification_all( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.mark_as_read_notification_all_endpoint.call_with_http_info(**kwargs) + kwargs['notification_id'] = \ + notification_id + return self.mark_as_read_notification_endpoint.call_with_http_info(**kwargs) - def memory_created_by_users( + def mark_as_read_notification_all( self, - workspace_id, **kwargs ): - """Get AI Memory CreatedBy Users # noqa: E501 + """Mark all notifications as read. # noqa: E501 - Returns a list of Users who created any memory item for this workspace # noqa: E501 + Mark all user in-platform notifications as read. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.memory_created_by_users(workspace_id, async_req=True) + >>> thread = api.mark_as_read_notification_all(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Workspace identifier Keyword Args: + workspace_id (str): Workspace ID where to mark notifications as read.. [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 @@ -15360,7 +15425,7 @@ def memory_created_by_users( async_req (bool): execute request asynchronously Returns: - MemoryItemCreatedByUsers + None If the method is called asynchronously, returns the request thread. """ @@ -15389,26 +15454,24 @@ def memory_created_by_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.memory_created_by_users_endpoint.call_with_http_info(**kwargs) + return self.mark_as_read_notification_all_endpoint.call_with_http_info(**kwargs) - def metadata_sync( + def memory_created_by_users( self, workspace_id, **kwargs ): - """(BETA) Sync Metadata to other services # noqa: E501 + """Get AI Memory CreatedBy Users # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 + Returns a list of Users who created any memory item for this workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync(workspace_id, async_req=True) + >>> thread = api.memory_created_by_users(workspace_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + workspace_id (str): Workspace identifier Keyword Args: _return_http_data_only (bool): response data without head status @@ -15443,7 +15506,7 @@ def metadata_sync( async_req (bool): execute request asynchronously Returns: - None + MemoryItemCreatedByUsers If the method is called asynchronously, returns the request thread. """ @@ -15474,21 +15537,25 @@ def metadata_sync( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) + return self.memory_created_by_users_endpoint.call_with_http_info(**kwargs) - def metadata_sync_organization( + def metric_permissions( self, + workspace_id, + metric_id, **kwargs ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 + """(BETA) Get Metric Permissions # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync_organization(async_req=True) + >>> thread = api.metric_permissions(workspace_id, metric_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + metric_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -15523,7 +15590,7 @@ def metadata_sync_organization( async_req (bool): execute request asynchronously Returns: - None + MetricPermissions If the method is called asynchronously, returns the request thread. """ @@ -15552,7 +15619,11 @@ def metadata_sync_organization( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['metric_id'] = \ + metric_id + return self.metric_permissions_endpoint.call_with_http_info(**kwargs) def outlier_detection( self, @@ -16318,6 +16389,84 @@ def register_workspace_upload_notification( workspace_id return self.register_workspace_upload_notification_endpoint.call_with_http_info(**kwargs) + def reload_observability_layout( + self, + **kwargs + ): + """Reload the managed AI observability layout # noqa: E501 + + Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reload_observability_layout(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: + 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) + return self.reload_observability_layout_endpoint.call_with_http_info(**kwargs) + def remove_targets( self, id, @@ -17863,7 +18012,7 @@ def tags( >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + workspace_id (str): Keyword Args: _return_http_data_only (bool): response data without head status diff --git a/gooddata-api-client/gooddata_api_client/api/ai_api.py b/gooddata-api-client/gooddata_api_client/api/ai_api.py index 175ff634a..e04eb3ccd 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_api.py @@ -33,6 +33,10 @@ from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument class AIApi(object): @@ -225,6 +229,72 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'create_entity_org_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_org_memory_item_in_document', + 'include', + ], + 'required': [ + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_org_memory_item_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.delete_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ 'response_type': None, @@ -331,6 +401,60 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'delete_entity_org_memory_items', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( settings={ 'response_type': (JsonApiKnowledgeRecommendationOutList,), @@ -572,28 +696,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_knowledge_recommendations_endpoint = _Endpoint( + self.get_all_entities_org_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'response_type': (JsonApiOrgMemoryItemOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'get_entity_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'get_all_entities_org_memory_items', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', 'filter', 'include', - 'x_gdc_validate_relations', + 'page', + 'size', + 'sort', 'meta_include', ], - 'required': [ - 'workspace_id', - 'object_id', - ], + 'required': [], 'nullable': [ ], 'enum': [ @@ -613,51 +734,51 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { - "ORIGIN": "origin", + "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': - (str,), 'filter': (str,), 'include': ([str],), - 'x_gdc_validate_relations': - (bool,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), 'meta_include': ([str],), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', 'meta_include': 'metaInclude', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', 'filter': 'query', 'include': 'query', - 'x_gdc_validate_relations': 'header', + 'page': 'query', + 'size': 'query', + 'sort': 'query', 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'sort': 'multi', 'meta_include': 'csv', } }, @@ -670,12 +791,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_memory_items_endpoint = _Endpoint( + self.get_entity_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'get_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'get_entity_knowledge_recommendations', 'http_method': 'GET', 'servers': None, }, @@ -711,9 +832,10 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", "ALL": "ALL" }, ('meta_include',): { @@ -767,89 +889,175 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.metadata_sync_endpoint = _Endpoint( + self.get_entity_memory_items_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'get_entity_memory_items', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ + 'include', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { 'workspace_id': (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], 'content_type': [], }, api_client=api_client ) - self.metadata_sync_organization_endpoint = _Endpoint( + self.get_entity_org_memory_items_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiOrgMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'get_entity_org_memory_items', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'id', + 'filter', + 'include', + ], + 'required': [ + 'id', ], - 'required': [], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ + 'id', ] }, root_map={ 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), }, 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', }, 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], 'content_type': [], }, api_client=api_client @@ -1021,9 +1229,93 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_knowledge_recommendations_endpoint = _Endpoint( + self.patch_entity_org_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'patch_entity_org_memory_items', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_patch_document': + (JsonApiOrgMemoryItemPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutList,), 'auth': [], 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search', 'operation_id': 'search_entities_knowledge_recommendations', @@ -1336,28 +1628,286 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'update_entity_org_memory_items', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_knowledge_recommendations( + self, + workspace_id, + json_api_knowledge_recommendation_post_optional_id_document, + **kwargs + ): + """Post Knowledge Recommendations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiKnowledgeRecommendationOutDocument + 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['json_api_knowledge_recommendation_post_optional_id_document'] = \ + json_api_knowledge_recommendation_post_optional_id_document + return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def create_entity_memory_items( + self, + workspace_id, + json_api_memory_item_post_optional_id_document, + **kwargs + ): + """Post Memory Items # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiMemoryItemOutDocument + 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['json_api_memory_item_post_optional_id_document'] = \ + json_api_memory_item_post_optional_id_document + return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def create_entity_knowledge_recommendations( + def create_entity_org_memory_items( self, - workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, + json_api_org_memory_item_in_document, **kwargs ): - """Post Knowledge Recommendations # noqa: E501 + """Post organization Memory Item entities # noqa: E501 + Organization-scoped AI memory item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -1390,7 +1940,7 @@ def create_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1419,33 +1969,29 @@ def create_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ - json_api_knowledge_recommendation_post_optional_id_document - return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def create_entity_memory_items( + def delete_entity_knowledge_recommendations( self, workspace_id, - json_api_memory_item_post_optional_id_document, + object_id, **kwargs ): - """Post Memory Items # noqa: E501 + """Delete a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -1478,7 +2024,7 @@ def create_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -1509,22 +2055,22 @@ def create_entity_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_memory_item_post_optional_id_document'] = \ - json_api_memory_item_post_optional_id_document - return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def delete_entity_knowledge_recommendations( + def delete_entity_memory_items( self, workspace_id, object_id, **kwargs ): - """Delete a Knowledge Recommendation # noqa: E501 + """Delete a Memory Item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -1597,25 +2143,23 @@ def delete_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def delete_entity_memory_items( + def delete_entity_org_memory_items( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Memory Item # noqa: E501 + """Delete an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1679,11 +2223,9 @@ def delete_entity_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) def get_all_entities_knowledge_recommendations( self, @@ -1865,28 +2407,25 @@ def get_all_entities_memory_items( workspace_id return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def get_entity_knowledge_recommendations( + def get_all_entities_org_memory_items( self, - workspace_id, - object_id, **kwargs ): - """Get a Knowledge Recommendation # noqa: E501 + """Get all organization Memory Item entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_org_memory_items(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + 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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1920,7 +2459,7 @@ def get_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiOrgMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -1949,24 +2488,20 @@ def get_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) - def get_entity_memory_items( + def get_entity_knowledge_recommendations( self, workspace_id, object_id, **kwargs ): - """Get a Memory Item # noqa: E501 + """Get a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -2010,7 +2545,7 @@ def get_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2043,26 +2578,31 @@ def get_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def metadata_sync( + def get_entity_memory_items( self, workspace_id, + object_id, **kwargs ): - """(BETA) Sync Metadata to other services # noqa: E501 + """Get a Memory Item # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync(workspace_id, async_req=True) + >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -2095,7 +2635,7 @@ def metadata_sync( async_req (bool): execute request asynchronously Returns: - None + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2126,23 +2666,29 @@ def metadata_sync( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def metadata_sync_organization( + def get_entity_org_memory_items( self, + id, **kwargs ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 + """Get an organization Memory Item entity # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync_organization(async_req=True) + >>> thread = api.get_entity_org_memory_items(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -2175,7 +2721,7 @@ def metadata_sync_organization( async_req (bool): execute request asynchronously Returns: - None + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2204,7 +2750,9 @@ def metadata_sync_organization( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) def patch_entity_knowledge_recommendations( self, @@ -2390,6 +2938,94 @@ def patch_entity_memory_items( json_api_memory_item_patch_document return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) + def patch_entity_org_memory_items( + self, + id, + json_api_org_memory_item_patch_document, + **kwargs + ): + """Patch an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + kwargs['json_api_org_memory_item_patch_document'] = \ + json_api_org_memory_item_patch_document + return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + def search_entities_knowledge_recommendations( self, workspace_id, @@ -2750,3 +3386,91 @@ def update_entity_memory_items( json_api_memory_item_in_document return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + def update_entity_org_memory_items( + self, + id, + json_api_org_memory_item_in_document, + **kwargs + ): + """Put an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + 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 76ae893f0..1b7576b5a 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 @@ -112,7 +112,7 @@ def __init__(self, api_client=None): ) self.analyze_statistics_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics', 'operation_id': 'analyze_statistics', @@ -162,9 +162,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -173,7 +171,7 @@ def __init__(self, api_client=None): ) self.create_ai_lake_pipe_table_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', 'operation_id': 'create_ai_lake_pipe_table', @@ -223,9 +221,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -234,7 +230,7 @@ def __init__(self, api_client=None): ) self.delete_ai_lake_pipe_table_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', 'operation_id': 'delete_ai_lake_pipe_table', @@ -285,16 +281,14 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client ) self.deprovision_ai_lake_database_instance_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}', 'operation_id': 'deprovision_ai_lake_database_instance', @@ -339,9 +333,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client @@ -581,9 +573,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -595,9 +590,9 @@ def __init__(self, api_client=None): 'instance_id': (str,), 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -655,9 +650,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -667,9 +665,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -725,9 +723,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -737,9 +738,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -798,9 +799,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -812,9 +816,9 @@ def __init__(self, api_client=None): 'instance_id': (str,), 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -872,9 +876,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -884,9 +891,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -914,7 +921,7 @@ def __init__(self, api_client=None): ) self.provision_ai_lake_database_instance_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances', 'operation_id': 'provision_ai_lake_database_instance', @@ -958,9 +965,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -969,7 +974,7 @@ def __init__(self, api_client=None): ) self.refresh_ai_lake_pipe_table_partition_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh', 'operation_id': 'refresh_ai_lake_pipe_table_partition', @@ -1025,9 +1030,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -1091,7 +1094,7 @@ def __init__(self, api_client=None): ) self.run_ai_lake_service_command_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/services/{serviceId}/commands/{commandName}/run', 'operation_id': 'run_ai_lake_service_command', @@ -1147,9 +1150,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -1353,7 +1354,7 @@ def analyze_statistics( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -1441,7 +1442,7 @@ def create_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -1529,7 +1530,7 @@ def delete_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -1615,7 +1616,7 @@ def deprovision_ai_lake_database_instance( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -2002,8 +2003,8 @@ def list_ai_lake_database_data_sources( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -2085,8 +2086,8 @@ def list_ai_lake_database_instances( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -2166,8 +2167,8 @@ def list_ai_lake_object_storages( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -2250,8 +2251,8 @@ def list_ai_lake_pipe_tables( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -2333,8 +2334,8 @@ def list_ai_lake_services( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -2450,7 +2451,7 @@ def provision_ai_lake_database_instance( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -2538,7 +2539,7 @@ def refresh_ai_lake_pipe_table_partition( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -2717,7 +2718,7 @@ def run_ai_lake_service_command( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ 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 0922a00de..2ca96a877 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 @@ -103,7 +103,7 @@ def __init__(self, api_client=None): ) self.deprovision_ai_lake_database_instance_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}', 'operation_id': 'deprovision_ai_lake_database_instance', @@ -148,9 +148,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client @@ -237,9 +235,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -251,9 +252,9 @@ def __init__(self, api_client=None): 'instance_id': (str,), 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -311,9 +312,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -323,9 +327,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -381,9 +385,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -393,9 +400,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -423,7 +430,7 @@ def __init__(self, api_client=None): ) self.provision_ai_lake_database_instance_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances', 'operation_id': 'provision_ai_lake_database_instance', @@ -467,9 +474,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -726,7 +731,7 @@ def deprovision_ai_lake_database_instance( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -860,8 +865,8 @@ def list_ai_lake_database_data_sources( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -943,8 +948,8 @@ def list_ai_lake_database_instances( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1024,8 +1029,8 @@ def list_ai_lake_object_storages( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1141,7 +1146,7 @@ def provision_ai_lake_database_instance( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py index 959cc5a9e..00b745b0f 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py @@ -42,7 +42,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.analyze_statistics_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics', 'operation_id': 'analyze_statistics', @@ -92,9 +92,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -103,7 +101,7 @@ def __init__(self, api_client=None): ) self.create_ai_lake_pipe_table_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', 'operation_id': 'create_ai_lake_pipe_table', @@ -153,9 +151,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -164,7 +160,7 @@ def __init__(self, api_client=None): ) self.delete_ai_lake_pipe_table_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', 'operation_id': 'delete_ai_lake_pipe_table', @@ -215,9 +211,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client @@ -310,9 +304,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -324,9 +321,9 @@ def __init__(self, api_client=None): 'instance_id': (str,), 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -356,7 +353,7 @@ def __init__(self, api_client=None): ) self.refresh_ai_lake_pipe_table_partition_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh', 'operation_id': 'refresh_ai_lake_pipe_table_partition', @@ -412,9 +409,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -475,7 +470,7 @@ def analyze_statistics( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -563,7 +558,7 @@ def create_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -651,7 +646,7 @@ def delete_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ @@ -791,8 +786,8 @@ def list_ai_lake_pipe_tables( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -914,7 +909,7 @@ def refresh_ai_lake_pipe_table_partition( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_services_operations_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_services_operations_api.py index 86675ee24..e3b5dce0b 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_services_operations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_services_operations_api.py @@ -167,9 +167,12 @@ def __init__(self, api_client=None): 'validations': { ('page',): { + 'inclusive_minimum': 0, }, ('size',): { + 'inclusive_maximum': 500, + 'inclusive_minimum': 1, }, ('meta_include',): { @@ -179,9 +182,9 @@ def __init__(self, api_client=None): }, 'openapi_types': { 'page': - (str,), + (int,), 'size': - (str,), + (int,), 'meta_include': ([str],), }, @@ -209,7 +212,7 @@ def __init__(self, api_client=None): ) self.run_ai_lake_service_command_endpoint = _Endpoint( settings={ - 'response_type': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/ailake/services/{serviceId}/commands/{commandName}/run', 'operation_id': 'run_ai_lake_service_command', @@ -265,9 +268,7 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [ 'application/json' ] @@ -456,8 +457,8 @@ def list_ai_lake_services( Keyword Args: - page (str): Zero-based page number.. [optional] if omitted the server will use the default value of "0" - size (str): Number of items per page.. [optional] if omitted the server will use the default value of "50" + page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 + size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -577,7 +578,7 @@ def run_ai_lake_service_command( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + None If the method is called asynchronously, returns the request thread. """ diff --git a/gooddata-api-client/gooddata_api_client/api/ai_observability_api.py b/gooddata-api-client/gooddata_api_client/api/ai_observability_api.py new file mode 100644 index 000000000..a782b927a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/ai_observability_api.py @@ -0,0 +1,156 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class AIObservabilityApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.reload_observability_layout_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/reloadObservabilityLayout', + 'operation_id': 'reload_observability_layout', + 'http_method': 'POST', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) + + def reload_observability_layout( + self, + **kwargs + ): + """Reload the managed AI observability layout # noqa: E501 + + Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.reload_observability_layout(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: + 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) + return self.reload_observability_layout_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/appearance_api.py b/gooddata-api-client/gooddata_api_client/api/appearance_api.py index ff1f55261..1aeb2c27e 100644 --- a/gooddata-api-client/gooddata_api_client/api/appearance_api.py +++ b/gooddata-api-client/gooddata_api_client/api/appearance_api.py @@ -30,6 +30,14 @@ from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList from gooddata_api_client.model.json_api_theme_patch_document import JsonApiThemePatchDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument class AppearanceApi(object): @@ -147,6 +155,156 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'create_entity_workspace_color_palettes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'create_entity_workspace_themes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.delete_entity_color_palettes_endpoint = _Endpoint( settings={ 'response_type': None, @@ -255,6 +413,112 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'delete_entity_workspace_color_palettes', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'delete_entity_workspace_themes', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_color_palettes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiColorPaletteOutList,), @@ -417,57 +681,101 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_color_palettes_endpoint = _Endpoint( + self.get_all_entities_workspace_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiColorPaletteOutDocument,), + 'response_type': (JsonApiWorkspaceColorPaletteOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'get_entity_color_palettes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'get_all_entities_workspace_color_palettes', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'origin', 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ - 'id', + 'workspace_id', ], 'nullable': [ ], 'enum': [ + 'origin', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'origin': (str,), 'filter': (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'origin': 'origin', 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', + 'workspace_id': 'path', + 'origin': 'query', 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ @@ -479,57 +787,101 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_themes_endpoint = _Endpoint( + self.get_all_entities_workspace_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutDocument,), + 'response_type': (JsonApiWorkspaceThemeOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'get_all_entities_workspace_themes', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'origin', 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', ], - 'required': [ - 'id', - ], 'nullable': [ ], 'enum': [ + 'origin', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'origin': (str,), 'filter': (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'origin': 'origin', 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', + 'workspace_id': 'path', + 'origin': 'query', 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ @@ -541,24 +893,22 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_color_palettes_endpoint = _Endpoint( + self.get_entity_color_palettes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiColorPaletteOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'patch_entity_color_palettes', - 'http_method': 'PATCH', + 'operation_id': 'get_entity_color_palettes', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_color_palette_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_color_palette_patch_document', ], 'nullable': [ ], @@ -582,8 +932,6 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_color_palette_patch_document': - (JsonApiColorPalettePatchDocument,), 'filter': (str,), }, @@ -593,7 +941,6 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_color_palette_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -604,31 +951,26 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] + 'content_type': [], }, api_client=api_client ) - self.patch_entity_themes_endpoint = _Endpoint( + self.get_entity_themes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiThemeOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'patch_entity_themes', - 'http_method': 'PATCH', + 'operation_id': 'get_entity_themes', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_theme_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_theme_patch_document', ], 'nullable': [ ], @@ -652,8 +994,6 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_theme_patch_document': - (JsonApiThemePatchDocument,), 'filter': (str,), }, @@ -663,7 +1003,6 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_theme_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -674,31 +1013,194 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'get_entity_workspace_color_palettes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ 'application/json', 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'get_entity_workspace_themes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', ] }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, api_client=api_client ) - self.update_entity_color_palettes_endpoint = _Endpoint( + self.patch_entity_color_palettes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiColorPaletteOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', - 'operation_id': 'update_entity_color_palettes', - 'http_method': 'PUT', + 'operation_id': 'patch_entity_color_palettes', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_color_palette_in_document', + 'json_api_color_palette_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_color_palette_in_document', + 'json_api_color_palette_patch_document', ], 'nullable': [ ], @@ -722,8 +1224,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_color_palette_in_document': - (JsonApiColorPaletteInDocument,), + 'json_api_color_palette_patch_document': + (JsonApiColorPalettePatchDocument,), 'filter': (str,), }, @@ -733,7 +1235,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_color_palette_in_document': 'body', + 'json_api_color_palette_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -751,24 +1253,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_themes_endpoint = _Endpoint( + self.patch_entity_themes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiThemeOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', - 'http_method': 'PUT', + 'operation_id': 'patch_entity_themes', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_theme_in_document', + 'json_api_theme_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_theme_in_document', + 'json_api_theme_patch_document', ], 'nullable': [ ], @@ -792,8 +1294,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), + 'json_api_theme_patch_document': + (JsonApiThemePatchDocument,), 'filter': (str,), }, @@ -803,7 +1305,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_theme_in_document': 'body', + 'json_api_theme_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -821,24 +1323,1285 @@ def __init__(self, api_client=None): }, api_client=api_client ) - - def create_entity_color_palettes( - self, - json_api_color_palette_in_document, - **kwargs - ): - """Post Color Pallettes # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): - - Keyword Args: + self.patch_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'patch_entity_workspace_color_palettes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_patch_document': + (JsonApiWorkspaceColorPalettePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.patch_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'patch_entity_workspace_themes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_theme_patch_document': + (JsonApiWorkspaceThemePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_theme_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/colorPalettes/{id}', + 'operation_id': 'update_entity_color_palettes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_color_palette_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_color_palette_in_document': + (JsonApiColorPaletteInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_color_palette_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'update_entity_themes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_theme_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_theme_in_document': + (JsonApiThemeInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_theme_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'update_entity_workspace_color_palettes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'update_entity_workspace_themes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_color_palettes( + self, + json_api_color_palette_in_document, + **kwargs + ): + """Post Color Pallettes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_color_palette_in_document (JsonApiColorPaletteInDocument): + + 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: + JsonApiColorPaletteOutDocument + 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['json_api_color_palette_in_document'] = \ + json_api_color_palette_in_document + return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + + def create_entity_themes( + self, + json_api_theme_in_document, + **kwargs + ): + """Post Theming # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_theme_in_document (JsonApiThemeInDocument): + + 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: + JsonApiThemeOutDocument + 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['json_api_theme_in_document'] = \ + json_api_theme_in_document + return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) + + def create_entity_workspace_color_palettes( + self, + workspace_id, + json_api_workspace_color_palette_in_document, + **kwargs + ): + """Post Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.create_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def create_entity_workspace_themes( + self, + workspace_id, + json_api_workspace_theme_in_document, + **kwargs + ): + """Post Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceThemeOutDocument + 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['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.create_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_color_palettes( + self, + id, + **kwargs + ): + """Delete a Color Pallette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_color_palettes(id, async_req=True) + >>> result = thread.get() + + Args: + 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: + 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['id'] = \ + id + return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_themes( + self, + id, + **kwargs + ): + """Delete Theming # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_themes(id, async_req=True) + >>> result = thread.get() + + Args: + 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: + 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['id'] = \ + id + return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_themes( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_color_palettes( + self, + **kwargs + ): + """Get all Color Pallettes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_color_palettes(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiColorPaletteOutList + 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.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_themes( + self, + **kwargs + ): + """Get all Theming entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_themes(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiThemeOutList + 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.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_color_palettes( + self, + workspace_id, + **kwargs + ): + """Get all Workspace Color Palettes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_color_palettes(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -871,7 +2634,7 @@ def create_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiWorkspaceColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -900,27 +2663,34 @@ def create_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def create_entity_themes( + def get_all_entities_workspace_themes( self, - json_api_theme_in_document, + workspace_id, **kwargs ): - """Post Theming # noqa: E501 + """Get all Workspace Themes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) + >>> thread = api.get_all_entities_workspace_themes(workspace_id, async_req=True) >>> result = thread.get() Args: - json_api_theme_in_document (JsonApiThemeInDocument): + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -953,7 +2723,7 @@ def create_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiWorkspaceThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -982,27 +2752,28 @@ def create_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_color_palettes( + def get_entity_color_palettes( self, id, **kwargs ): - """Delete a Color Pallette # noqa: E501 + """Get Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_color_palettes(id, async_req=True) + >>> thread = api.get_entity_color_palettes(id, async_req=True) >>> result = thread.get() Args: id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 @@ -1035,7 +2806,7 @@ def delete_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - None + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1066,25 +2837,26 @@ def delete_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_themes( + def get_entity_themes( self, id, **kwargs ): - """Delete Theming # noqa: E501 + """Get Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_themes(id, async_req=True) + >>> thread = api.get_entity_themes(id, async_req=True) >>> result = thread.get() Args: id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 @@ -1117,7 +2889,7 @@ def delete_entity_themes( async_req (bool): execute request asynchronously Returns: - None + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1148,26 +2920,29 @@ def delete_entity_themes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_color_palettes( + def get_entity_workspace_color_palettes( self, + workspace_id, + object_id, **kwargs ): - """Get all Color Pallettes # noqa: E501 + """Get a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_color_palettes(async_req=True) + >>> thread = api.get_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1201,7 +2976,7 @@ def get_all_entities_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutList + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1230,26 +3005,33 @@ def get_all_entities_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_themes( + def get_entity_workspace_themes( self, + workspace_id, + object_id, **kwargs ): - """Get all Theming entities # noqa: E501 + """Get a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_themes(async_req=True) + >>> thread = api.get_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1283,7 +3065,7 @@ def get_all_entities_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutList + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1312,23 +3094,29 @@ def get_all_entities_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def get_entity_color_palettes( + def patch_entity_color_palettes( self, id, + json_api_color_palette_patch_document, **kwargs ): - """Get Color Pallette # noqa: E501 + """Patch Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_color_palettes(id, async_req=True) + >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: id (str): + json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -1395,23 +3183,27 @@ def get_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_color_palette_patch_document'] = \ + json_api_color_palette_patch_document + return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_entity_themes( + def patch_entity_themes( self, id, + json_api_theme_patch_document, **kwargs ): - """Get Theming # noqa: E501 + """Patch Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_themes(id, async_req=True) + >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) >>> result = thread.get() Args: id (str): + json_api_theme_patch_document (JsonApiThemePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -1478,25 +3270,29 @@ def get_entity_themes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_theme_patch_document'] = \ + json_api_theme_patch_document + return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) - def patch_entity_color_palettes( + def patch_entity_workspace_color_palettes( self, - id, - json_api_color_palette_patch_document, + workspace_id, + object_id, + json_api_workspace_color_palette_patch_document, **kwargs ): - """Patch Color Pallette # noqa: E501 + """Patch a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_patch_document (JsonApiWorkspaceColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -1532,7 +3328,7 @@ def patch_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1561,29 +3357,33 @@ def patch_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - - def patch_entity_themes( + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_patch_document'] = \ + json_api_workspace_color_palette_patch_document + return self.patch_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_themes( self, - id, - json_api_theme_patch_document, + workspace_id, + object_id, + json_api_workspace_theme_patch_document, **kwargs ): - """Patch Theming # noqa: E501 + """Patch a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_theme_patch_document (JsonApiThemePatchDocument): + workspace_id (str): + object_id (str): + json_api_workspace_theme_patch_document (JsonApiWorkspaceThemePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -1619,7 +3419,7 @@ def patch_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1648,11 +3448,13 @@ def patch_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_patch_document'] = \ - json_api_theme_patch_document - return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_theme_patch_document'] = \ + json_api_workspace_theme_patch_document + return self.patch_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) def update_entity_color_palettes( self, @@ -1828,3 +3630,185 @@ def update_entity_themes( json_api_theme_in_document return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) + def update_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + json_api_workspace_color_palette_in_document, + **kwargs + ): + """Put a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.update_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_themes( + self, + workspace_id, + object_id, + json_api_workspace_theme_in_document, + **kwargs + ): + """Put a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceThemeOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.update_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + 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 e556068b2..849daf2a1 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -111,6 +111,8 @@ from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList @@ -151,6 +153,10 @@ from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument @@ -191,6 +197,10 @@ from gooddata_api_client.model.json_api_visualization_object_patch_document import JsonApiVisualizationObjectPatchDocument from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList @@ -199,6 +209,11 @@ from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from gooddata_api_client.model.json_api_workspace_data_filter_setting_patch_document import JsonApiWorkspaceDataFilterSettingPatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList @@ -208,6 +223,10 @@ from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument class EntitiesApi(object): @@ -1977,6 +1996,72 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'create_entity_org_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_org_memory_item_in_document', + 'include', + ], + 'required': [ + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_org_memory_item_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_organization_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiOrganizationSettingOutDocument,), @@ -2549,6 +2634,81 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'create_entity_workspace_color_palettes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), @@ -2725,6 +2885,81 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'create_entity_workspace_export_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_export_template_post_optional_id_document': + (JsonApiWorkspaceExportTemplatePostOptionalIdDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_export_template_post_optional_id_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_workspace_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceSettingOutDocument,), @@ -2800,6 +3035,81 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'create_entity_workspace_themes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_workspaces_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceOutDocument,), @@ -4229,12 +4539,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_organization_settings_endpoint = _Endpoint( + self.delete_entity_org_memory_items_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'delete_entity_organization_settings', + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'delete_entity_org_memory_items', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_entity_organization_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'delete_entity_organization_settings', 'http_method': 'DELETE', 'servers': None, }, @@ -4664,6 +5028,59 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'delete_entity_workspace_color_palettes', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': None, @@ -4770,12 +5187,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( + self.delete_entity_workspace_export_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'delete_entity_workspace_export_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -4823,50 +5240,49 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspaces_endpoint = _Endpoint( + self.delete_entity_workspace_settings_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'delete_entity_workspaces', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'delete_entity_workspace_settings', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'object_id', ], 'required': [ - 'id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'object_id': (str,), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', }, 'location_map': { - 'id': 'path', + 'workspace_id': 'path', + 'object_id': 'path', }, 'collection_format_map': { } @@ -4877,141 +5293,103 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_automations_workspace_automations_endpoint = _Endpoint( + self.delete_entity_workspace_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceAutomationOutList,), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', - 'operation_id': 'get_all_automations_workspace_automations', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'delete_entity_workspace_themes', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', ], - 'required': [], 'nullable': [ ], 'enum': [ - 'include', - 'meta_include', ], 'validation': [ - 'meta_include', ] }, root_map={ 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "NOTIFICATIONCHANNELS": "notificationChannels", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERIDENTIFIERS": "userIdentifiers", - "EXPORTDEFINITIONS": "exportDefinitions", - "USERS": "users", - "AUTOMATIONRESULTS": "automationResults", - "WORKSPACE": "workspace", - "NOTIFICATIONCHANNEL": "notificationChannel", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "RECIPIENTS": "recipients", - "ALL": "ALL" - }, - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { - 'filter': + 'workspace_id': + (str,), + 'object_id': (str,), - 'include': - ([str],), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), }, 'attribute_map': { - 'filter': 'filter', - 'include': 'include', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', }, 'location_map': { - 'filter': 'query', - 'include': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', + 'workspace_id': 'path', + 'object_id': 'path', }, 'collection_format_map': { - 'include': 'csv', - 'sort': 'multi', - 'meta_include': 'csv', } }, headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client ) - self.get_all_entities_endpoint = _Endpoint( + self.delete_entity_workspaces_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/llmEndpoints', - 'operation_id': 'get_all_entities', - 'http_method': 'GET', + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'delete_entity_workspaces', + 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ + 'id', + ], + 'required': [ + 'id', ], - 'required': [], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'id', ] }, root_map={ 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { + 'id': + (str,), }, 'attribute_map': { + 'id': 'id', }, 'location_map': { + 'id': 'path', }, 'collection_format_map': { } @@ -5022,12 +5400,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_agents_endpoint = _Endpoint( + self.get_all_automations_workspace_automations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAgentOutList,), + 'response_type': (JsonApiWorkspaceAutomationOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/agents', - 'operation_id': 'get_all_entities_agents', + 'endpoint_path': '/api/v1/entities/organization/workspaceAutomations', + 'operation_id': 'get_all_automations_workspace_automations', 'http_method': 'GET', 'servers': None, }, @@ -5060,8 +5438,153 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { + "WORKSPACES": "workspaces", + "NOTIFICATIONCHANNELS": "notificationChannels", + "ANALYTICALDASHBOARDS": "analyticalDashboards", "USERIDENTIFIERS": "userIdentifiers", - "USERGROUPS": "userGroups", + "EXPORTDEFINITIONS": "exportDefinitions", + "USERS": "users", + "AUTOMATIONRESULTS": "automationResults", + "WORKSPACE": "workspace", + "NOTIFICATIONCHANNEL": "notificationChannel", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "RECIPIENTS": "recipients", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/llmEndpoints', + 'operation_id': 'get_all_entities', + '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': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_agents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAgentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/agents', + 'operation_id': 'get_all_entities_agents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "USERGROUPS": "userGroups", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "ALL": "ALL" @@ -7322,110 +7845,33 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_identity_providers_endpoint = _Endpoint( + self.get_all_entities_fiscal_calendars_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutList,), + 'response_type': (JsonApiFiscalCalendarOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders', - 'operation_id': 'get_all_entities_identity_providers', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars', + 'operation_id': 'get_all_entities_fiscal_calendars', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('meta_include',): { - - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'filter': - (str,), - 'page': - (int,), - 'size': - (int,), - 'sort': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'filter': 'filter', - 'page': 'page', - 'size': 'size', - 'sort': 'sort', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'filter': 'query', - 'page': 'query', - 'size': 'query', - 'sort': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'sort': 'multi', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_all_entities_ip_allowlist_policies_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiIpAllowlistPolicyOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/ipAllowlistPolicies', - 'operation_id': 'get_all_entities_ip_allowlist_policies', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'filter', - 'include', - 'page', - 'size', - 'sort', - 'meta_include', + 'required': [ + 'workspace_id', ], - 'required': [], 'nullable': [ ], 'enum': [ - 'include', + 'origin', 'meta_include', ], 'validation': [ @@ -7439,11 +7885,11 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { + ('origin',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, ('meta_include',): { @@ -7453,37 +7899,44 @@ def __init__(self, api_client=None): }, }, 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), 'filter': (str,), - 'include': - ([str],), 'page': (int,), 'size': (int,), 'sort': ([str],), + 'x_gdc_validate_relations': + (bool,), 'meta_include': ([str],), }, 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', 'filter': 'filter', - 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', 'filter': 'query', - 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', + 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -7497,12 +7950,187 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_jwks_endpoint = _Endpoint( + self.get_all_entities_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutList,), + 'response_type': (JsonApiIdentityProviderOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', + 'endpoint_path': '/api/v1/entities/identityProviders', + 'operation_id': 'get_all_entities_identity_providers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_ip_allowlist_policies_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiIpAllowlistPolicyOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/ipAllowlistPolicies', + 'operation_id': 'get_all_entities_ip_allowlist_policies', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_jwks_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiJwkOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/jwks', + 'operation_id': 'get_all_entities_jwks', 'http_method': 'GET', 'servers': None, }, @@ -8308,6 +8936,101 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'get_all_entities_org_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_organization_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiOrganizationSettingOutList,), @@ -9200,6 +9923,112 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'get_all_entities_workspace_color_palettes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), @@ -9438,6 +10267,112 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'get_all_entities_workspace_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_workspace_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceSettingOutList,), @@ -9544,6 +10479,112 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'get_all_entities_workspace_themes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_workspaces_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceOutList,), @@ -11683,6 +12724,72 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_fiscal_calendars_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFiscalCalendarOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}', + 'operation_id': 'get_entity_fiscal_calendars', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_entity_identity_providers_endpoint = _Endpoint( settings={ 'response_type': (JsonApiIdentityProviderOutDocument,), @@ -12463,74 +13570,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_organization_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiOrganizationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', - 'operation_id': 'get_entity_organization_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_organizations_endpoint = _Endpoint( + self.get_entity_org_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationOutDocument,), + 'response_type': (JsonApiOrgMemoryItemOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', - 'operation_id': 'get_entity_organizations', + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'get_entity_org_memory_items', 'http_method': 'GET', 'servers': None, }, @@ -12539,7 +13584,6 @@ def __init__(self, api_client=None): 'id', 'filter', 'include', - 'meta_include', ], 'required': [ 'id', @@ -12548,11 +13592,9 @@ def __init__(self, api_client=None): ], 'enum': [ 'include', - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -12563,101 +13605,6 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "IDENTITYPROVIDERS": "identityProviders", - "BOOTSTRAPUSER": "bootstrapUser", - "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", - "IDENTITYPROVIDER": "identityProvider", - "ALL": "ALL" - }, - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - 'include': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - 'meta_include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_parameters_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiParameterOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}', - 'operation_id': 'get_entity_parameters', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'object_id', - 'filter', - 'include', - 'x_gdc_validate_relations', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'object_id', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - 'meta_include', - ], - 'validation': [ - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('meta_include',): { - - }, }, 'allowed_values': { ('include',): { @@ -12667,46 +13614,27 @@ def __init__(self, api_client=None): "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, - ('meta_include',): { - - "ORIGIN": "origin", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': + 'id': (str,), 'filter': (str,), 'include': ([str],), - 'x_gdc_validate_relations': - (bool,), - 'meta_include': - ([str],), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', + 'id': 'id', 'filter': 'filter', 'include': 'include', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - 'meta_include': 'metaInclude', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', + 'id': 'path', 'filter': 'query', 'include': 'query', - 'x_gdc_validate_relations': 'header', - 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', - 'meta_include': 'csv', } }, headers_map={ @@ -12718,12 +13646,267 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_themes_endpoint = _Endpoint( + self.get_entity_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutDocument,), + 'response_type': (JsonApiOrganizationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', + 'endpoint_path': '/api/v1/entities/organizationSettings/{id}', + 'operation_id': 'get_entity_organization_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_organizations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrganizationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/admin/organizations/{id}', + 'operation_id': 'get_entity_organizations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + 'meta_include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'id', + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "IDENTITYPROVIDERS": "identityProviders", + "BOOTSTRAPUSER": "bootstrapUser", + "BOOTSTRAPUSERGROUP": "bootstrapUserGroup", + "IDENTITYPROVIDER": "identityProvider", + "ALL": "ALL" + }, + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_parameters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiParameterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}', + 'operation_id': 'get_entity_parameters', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'get_entity_themes', 'http_method': 'GET', 'servers': None, }, @@ -13267,12 +14450,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( + self.get_entity_workspace_color_palettes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'get_entity_workspace_data_filter_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'get_entity_workspace_color_palettes', 'http_method': 'GET', 'servers': None, }, @@ -13281,7 +14464,6 @@ def __init__(self, api_client=None): 'workspace_id', 'object_id', 'filter', - 'include', 'x_gdc_validate_relations', 'meta_include', ], @@ -13292,7 +14474,6 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', 'meta_include', ], 'validation': [ @@ -13306,12 +14487,6 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", - "ALL": "ALL" - }, ('meta_include',): { "ORIGIN": "origin", @@ -13326,8 +14501,6 @@ def __init__(self, api_client=None): (str,), 'filter': (str,), - 'include': - ([str],), 'x_gdc_validate_relations': (bool,), 'meta_include': @@ -13337,7 +14510,6 @@ def __init__(self, api_client=None): 'workspace_id': 'workspaceId', 'object_id': 'objectId', 'filter': 'filter', - 'include': 'include', 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, @@ -13345,12 +14517,10 @@ def __init__(self, api_client=None): 'workspace_id': 'path', 'object_id': 'path', 'filter': 'query', - 'include': 'query', 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', 'meta_include': 'csv', } }, @@ -13363,12 +14533,108 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_workspace_data_filters_endpoint = _Endpoint( + self.get_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'get_entity_workspace_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'get_entity_workspace_data_filter_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'get_entity_workspace_data_filters', 'http_method': 'GET', 'servers': None, }, @@ -13459,6 +14725,89 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'get_entity_workspace_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_entity_workspace_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceSettingOutDocument,), @@ -13542,6 +14891,89 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'get_entity_workspace_themes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_entity_workspaces_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceOutDocument,), @@ -15792,6 +17224,90 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'patch_entity_org_memory_items', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_patch_document': + (JsonApiOrgMemoryItemPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.patch_entity_organization_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiOrganizationSettingOutDocument,), @@ -16447,6 +17963,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'patch_entity_workspace_color_palettes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_patch_document': + (JsonApiWorkspaceColorPalettePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.patch_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), @@ -16611,12 +18196,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_workspace_settings_endpoint = _Endpoint( + self.patch_entity_workspace_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceSettingOutDocument,), + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'patch_entity_workspace_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'patch_entity_workspace_export_templates', 'http_method': 'PATCH', 'servers': None, }, @@ -16624,13 +18209,13 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_workspace_setting_patch_document', + 'json_api_workspace_export_template_patch_document', 'filter', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_workspace_setting_patch_document', + 'json_api_workspace_export_template_patch_document', ], 'nullable': [ ], @@ -16649,8 +18234,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_workspace_setting_patch_document': - (JsonApiWorkspaceSettingPatchDocument,), + 'json_api_workspace_export_template_patch_document': + (JsonApiWorkspaceExportTemplatePatchDocument,), 'filter': (str,), }, @@ -16662,7 +18247,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_workspace_setting_patch_document': 'body', + 'json_api_workspace_export_template_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -16680,75 +18265,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_workspaces_endpoint = _Endpoint( + self.patch_entity_workspace_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceOutDocument,), + 'response_type': (JsonApiWorkspaceSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{id}', - 'operation_id': 'patch_entity_workspaces', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'patch_entity_workspace_settings', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_workspace_patch_document', + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_patch_document', 'filter', - 'include', ], 'required': [ - 'id', - 'json_api_workspace_patch_document', + 'workspace_id', + 'object_id', + 'json_api_workspace_setting_patch_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { - ('include',): { - - "WORKSPACES": "workspaces", - "PARENT": "parent", - "ALL": "ALL" - }, }, 'openapi_types': { - 'id': + 'workspace_id': (str,), - 'json_api_workspace_patch_document': - (JsonApiWorkspacePatchDocument,), + 'object_id': + (str,), + 'json_api_workspace_setting_patch_document': + (JsonApiWorkspaceSettingPatchDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', - 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_workspace_patch_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_setting_patch_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -16763,30 +18334,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_aggregated_facts_endpoint = _Endpoint( + self.patch_entity_workspace_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAggregatedFactOutList,), + 'response_type': (JsonApiWorkspaceThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search', - 'operation_id': 'search_entities_aggregated_facts', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'patch_entity_workspace_themes', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', + 'object_id', + 'json_api_workspace_theme_patch_document', + 'filter', ], 'required': [ 'workspace_id', - 'entity_search_body', + 'object_id', + 'json_api_workspace_theme_patch_document', ], 'nullable': [ ], 'enum': [ - 'origin', ], 'validation': [ ] @@ -16795,33 +18366,27 @@ def __init__(self, api_client=None): 'validations': { }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, }, 'openapi_types': { 'workspace_id': (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': + 'object_id': + (str,), + 'json_api_workspace_theme_patch_document': + (JsonApiWorkspaceThemePatchDocument,), + 'filter': (str,), - 'x_gdc_validate_relations': - (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'object_id': 'objectId', + 'filter': 'filter', }, 'location_map': { 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', + 'object_id': 'path', + 'json_api_workspace_theme_patch_document': 'body', + 'filter': 'query', }, 'collection_format_map': { } @@ -16832,72 +18397,81 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json' + 'application/json', + 'application/vnd.gooddata.api+json' ] }, api_client=api_client ) - self.search_entities_analytical_dashboards_endpoint = _Endpoint( + self.patch_entity_workspaces_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAnalyticalDashboardOutList,), + 'response_type': (JsonApiWorkspaceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search', - 'operation_id': 'search_entities_analytical_dashboards', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{id}', + 'operation_id': 'patch_entity_workspaces', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', + 'id', + 'json_api_workspace_patch_document', + 'filter', + 'include', ], 'required': [ - 'workspace_id', - 'entity_search_body', + 'id', + 'json_api_workspace_patch_document', ], 'nullable': [ ], 'enum': [ - 'origin', + 'include', ], 'validation': [ + 'id', ] }, root_map={ 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { - ('origin',): { + ('include',): { - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" + "WORKSPACES": "workspaces", + "PARENT": "parent", + "ALL": "ALL" }, }, 'openapi_types': { - 'workspace_id': + 'id': (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': + 'json_api_workspace_patch_document': + (JsonApiWorkspacePatchDocument,), + 'filter': (str,), - 'x_gdc_validate_relations': - (bool,), + 'include': + ([str],), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'id': 'id', + 'filter': 'filter', + 'include': 'include', }, 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', + 'id': 'path', + 'json_api_workspace_patch_document': 'body', + 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -16906,17 +18480,18 @@ def __init__(self, api_client=None): 'application/vnd.gooddata.api+json' ], 'content_type': [ - 'application/json' + 'application/json', + 'application/vnd.gooddata.api+json' ] }, api_client=api_client ) - self.search_entities_attribute_hierarchies_endpoint = _Endpoint( + self.search_entities_aggregated_facts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAttributeHierarchyOutList,), + 'response_type': (JsonApiAggregatedFactOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search', - 'operation_id': 'search_entities_attribute_hierarchies', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search', + 'operation_id': 'search_entities_aggregated_facts', 'http_method': 'POST', 'servers': None, }, @@ -16985,12 +18560,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_attributes_endpoint = _Endpoint( + self.search_entities_analytical_dashboards_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAttributeOutList,), + 'response_type': (JsonApiAnalyticalDashboardOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/search', - 'operation_id': 'search_entities_attributes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search', + 'operation_id': 'search_entities_analytical_dashboards', 'http_method': 'POST', 'servers': None, }, @@ -17059,12 +18634,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_automation_results_endpoint = _Endpoint( + self.search_entities_attribute_hierarchies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAutomationResultOutList,), + 'response_type': (JsonApiAttributeHierarchyOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automationResults/search', - 'operation_id': 'search_entities_automation_results', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search', + 'operation_id': 'search_entities_attribute_hierarchies', 'http_method': 'POST', 'servers': None, }, @@ -17133,12 +18708,160 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_automations_endpoint = _Endpoint( + self.search_entities_attributes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiAutomationOutList,), + 'response_type': (JsonApiAttributeOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/search', - 'operation_id': 'search_entities_automations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/attributes/search', + 'operation_id': 'search_entities_attributes', + '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_automation_results_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationResultOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automationResults/search', + 'operation_id': 'search_entities_automation_results', + '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_automations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiAutomationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/automations/search', + 'operation_id': 'search_entities_automations', 'http_method': 'POST', 'servers': None, }, @@ -20388,6 +22111,90 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'update_entity_org_memory_items', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_organization_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiOrganizationSettingOutDocument,), @@ -21119,6 +22926,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'update_entity_workspace_color_palettes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceDataFilterSettingOutDocument,), @@ -21283,6 +23159,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'update_entity_workspace_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_export_template_in_document': + (JsonApiWorkspaceExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_workspace_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceSettingOutDocument,), @@ -21352,6 +23297,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'update_entity_workspace_themes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.update_entity_workspaces_endpoint = _Endpoint( settings={ 'response_type': (JsonApiWorkspaceOutDocument,), @@ -22165,7 +24179,1199 @@ def create_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiCustomApplicationSettingOutDocument + 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['json_api_custom_application_setting_post_optional_id_document'] = \ + json_api_custom_application_setting_post_optional_id_document + return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def create_entity_custom_geo_collections( + self, + json_api_custom_geo_collection_in_document, + **kwargs + ): + """Post Custom Geo Collections # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + + 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: + JsonApiCustomGeoCollectionOutDocument + 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['json_api_custom_geo_collection_in_document'] = \ + json_api_custom_geo_collection_in_document + return self.create_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + + def create_entity_custom_user_application_settings( + self, + user_id, + json_api_custom_user_application_setting_post_optional_id_document, + **kwargs + ): + """Post a new custom application setting for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_custom_user_application_settings(user_id, json_api_custom_user_application_setting_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + json_api_custom_user_application_setting_post_optional_id_document (JsonApiCustomUserApplicationSettingPostOptionalIdDocument): + + 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: + JsonApiCustomUserApplicationSettingOutDocument + 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['user_id'] = \ + user_id + kwargs['json_api_custom_user_application_setting_post_optional_id_document'] = \ + json_api_custom_user_application_setting_post_optional_id_document + return self.create_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + + def create_entity_dashboard_plugins( + self, + workspace_id, + json_api_dashboard_plugin_post_optional_id_document, + **kwargs + ): + """Post Plugins # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiDashboardPluginOutDocument + 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['json_api_dashboard_plugin_post_optional_id_document'] = \ + json_api_dashboard_plugin_post_optional_id_document + return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def create_entity_data_sources( + self, + json_api_data_source_in_document, + **kwargs + ): + """Post Data Sources # noqa: E501 + + Data Source - represents data source for the workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_data_source_in_document (JsonApiDataSourceInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiDataSourceOutDocument + 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['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) + + def create_entity_export_definitions( + self, + workspace_id, + json_api_export_definition_post_optional_id_document, + **kwargs + ): + """Post Export Definitions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiExportDefinitionOutDocument + 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['json_api_export_definition_post_optional_id_document'] = \ + json_api_export_definition_post_optional_id_document + return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document, + **kwargs + ): + """Post Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + + 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: + JsonApiExportTemplateOutDocument + 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['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + + def create_entity_filter_contexts( + self, + workspace_id, + json_api_filter_context_post_optional_id_document, + **kwargs + ): + """Post Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiFilterContextOutDocument + 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['json_api_filter_context_post_optional_id_document'] = \ + json_api_filter_context_post_optional_id_document + return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def create_entity_filter_views( + self, + workspace_id, + json_api_filter_view_in_document, + **kwargs + ): + """Post Filter views # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiFilterViewOutDocument + 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['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def create_entity_identity_providers( + self, + json_api_identity_provider_in_document, + **kwargs + ): + """Post Identity Providers # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + + 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: + JsonApiIdentityProviderOutDocument + 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['json_api_identity_provider_in_document'] = \ + json_api_identity_provider_in_document + return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + + def create_entity_ip_allowlist_policies( + self, + json_api_ip_allowlist_policy_in_document, + **kwargs + ): + """Post IpAllowlistPolicy entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_ip_allowlist_policies(json_api_ip_allowlist_policy_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiIpAllowlistPolicyOutDocument + 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['json_api_ip_allowlist_policy_in_document'] = \ + json_api_ip_allowlist_policy_in_document + return self.create_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + + def create_entity_jwks( + self, + json_api_jwk_in_document, + **kwargs + ): + """Post Jwks # noqa: E501 + + Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_jwk_in_document (JsonApiJwkInDocument): + + 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: + JsonApiJwkOutDocument + 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['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def create_entity_knowledge_recommendations( + self, + workspace_id, + json_api_knowledge_recommendation_post_optional_id_document, + **kwargs + ): + """Post Knowledge Recommendations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiKnowledgeRecommendationOutDocument + 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['json_api_knowledge_recommendation_post_optional_id_document'] = \ + json_api_knowledge_recommendation_post_optional_id_document + return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def create_entity_llm_providers( + self, + json_api_llm_provider_in_document, + **kwargs + ): + """Post LLM Provider entities # noqa: E501 + + LLM Provider - connection configuration for LLM services # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + + 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: + JsonApiLlmProviderOutDocument + 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['json_api_llm_provider_in_document'] = \ + json_api_llm_provider_in_document + return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + + def create_entity_memory_items( + self, + workspace_id, + json_api_memory_item_post_optional_id_document, + **kwargs + ): + """Post Memory Items # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22196,27 +25402,31 @@ def create_entity_custom_application_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_custom_application_setting_post_optional_id_document'] = \ - json_api_custom_application_setting_post_optional_id_document - return self.create_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_memory_item_post_optional_id_document'] = \ + json_api_memory_item_post_optional_id_document + return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def create_entity_custom_geo_collections( + def create_entity_metrics( self, - json_api_custom_geo_collection_in_document, + workspace_id, + json_api_metric_post_optional_id_document, **kwargs ): - """Post Custom Geo Collections # noqa: E501 + """Post Metrics # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document, async_req=True) + >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + workspace_id (str): + json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -22249,7 +25459,7 @@ def create_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiMetricOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22278,27 +25488,27 @@ def create_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.create_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_metric_post_optional_id_document'] = \ + json_api_metric_post_optional_id_document + return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) - def create_entity_custom_user_application_settings( + def create_entity_notification_channels( self, - user_id, - json_api_custom_user_application_setting_post_optional_id_document, + json_api_notification_channel_post_optional_id_document, **kwargs ): - """Post a new custom application setting for the user # noqa: E501 + """Post Notification Channel entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_custom_user_application_settings(user_id, json_api_custom_user_application_setting_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - json_api_custom_user_application_setting_post_optional_id_document (JsonApiCustomUserApplicationSettingPostOptionalIdDocument): + json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -22333,7 +25543,7 @@ def create_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22362,33 +25572,29 @@ def create_entity_custom_user_application_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_custom_user_application_setting_post_optional_id_document'] = \ - json_api_custom_user_application_setting_post_optional_id_document - return self.create_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_notification_channel_post_optional_id_document'] = \ + json_api_notification_channel_post_optional_id_document + return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def create_entity_dashboard_plugins( + def create_entity_org_memory_items( self, - workspace_id, - json_api_dashboard_plugin_post_optional_id_document, + json_api_org_memory_item_in_document, **kwargs ): - """Post Plugins # noqa: E501 + """Post organization Memory Item entities # noqa: E501 + Organization-scoped AI memory item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -22421,7 +25627,7 @@ def create_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22450,31 +25656,27 @@ def create_entity_dashboard_plugins( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def create_entity_data_sources( + def create_entity_organization_settings( self, - json_api_data_source_in_document, + json_api_organization_setting_in_document, **kwargs ): - """Post Data Sources # noqa: E501 + """Post Organization Setting entities # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) + >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) >>> result = thread.get() Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): + json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): Keyword Args: - meta_include ([str]): Include Meta objects.. [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 @@ -22507,7 +25709,7 @@ def create_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22536,27 +25738,27 @@ def create_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_organization_setting_in_document'] = \ + json_api_organization_setting_in_document + return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_export_definitions( + def create_entity_parameters( self, workspace_id, - json_api_export_definition_post_optional_id_document, + json_api_parameter_post_optional_id_document, **kwargs ): - """Post Export Definitions # noqa: E501 + """Post Parameters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_parameters(workspace_id, json_api_parameter_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): + json_api_parameter_post_optional_id_document (JsonApiParameterPostOptionalIdDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -22593,7 +25795,7 @@ def create_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiParameterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22624,25 +25826,25 @@ def create_entity_export_definitions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_parameter_post_optional_id_document'] = \ + json_api_parameter_post_optional_id_document + return self.create_entity_parameters_endpoint.call_with_http_info(**kwargs) - def create_entity_export_templates( + def create_entity_themes( self, - json_api_export_template_post_optional_id_document, + json_api_theme_in_document, **kwargs ): - """Post Export Template entities # noqa: E501 + """Post Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) >>> result = thread.get() Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + json_api_theme_in_document (JsonApiThemeInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -22677,7 +25879,7 @@ def create_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22706,27 +25908,27 @@ def create_entity_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_theme_in_document'] = \ + json_api_theme_in_document + return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - def create_entity_filter_contexts( + def create_entity_user_data_filters( self, workspace_id, - json_api_filter_context_post_optional_id_document, + json_api_user_data_filter_post_optional_id_document, **kwargs ): - """Post Filter Context # noqa: E501 + """Post User Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): + json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -22763,7 +25965,7 @@ def create_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiUserDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22794,27 +25996,26 @@ def create_entity_filter_contexts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_data_filter_post_optional_id_document'] = \ + json_api_user_data_filter_post_optional_id_document + return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def create_entity_filter_views( + def create_entity_user_groups( self, - workspace_id, - json_api_filter_view_in_document, + json_api_user_group_in_document, **kwargs ): - """Post Filter views # noqa: E501 + """Post User Group entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) + >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): + json_api_user_group_in_document (JsonApiUserGroupInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -22850,7 +26051,7 @@ def create_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22879,27 +26080,27 @@ def create_entity_filter_views( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_group_in_document'] = \ + json_api_user_group_in_document + return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def create_entity_identity_providers( + def create_entity_user_settings( self, - json_api_identity_provider_in_document, + user_id, + json_api_user_setting_in_document, **kwargs ): - """Post Identity Providers # noqa: E501 + """Post new user settings for the user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) + >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) >>> result = thread.get() Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + user_id (str): + json_api_user_setting_in_document (JsonApiUserSettingInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -22934,7 +26135,7 @@ def create_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiUserSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -22963,25 +26164,28 @@ def create_entity_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + kwargs['json_api_user_setting_in_document'] = \ + json_api_user_setting_in_document + return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_ip_allowlist_policies( + def create_entity_users( self, - json_api_ip_allowlist_policy_in_document, + json_api_user_in_document, **kwargs ): - """Post IpAllowlistPolicy entities # noqa: E501 + """Post User entities # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_ip_allowlist_policies(json_api_ip_allowlist_policy_in_document, async_req=True) + >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) >>> result = thread.get() Args: - json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + json_api_user_in_document (JsonApiUserInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -23017,7 +26221,7 @@ def create_entity_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23046,28 +26250,31 @@ def create_entity_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_ip_allowlist_policy_in_document'] = \ - json_api_ip_allowlist_policy_in_document - return self.create_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_in_document'] = \ + json_api_user_in_document + return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - def create_entity_jwks( + def create_entity_visualization_objects( self, - json_api_jwk_in_document, + workspace_id, + json_api_visualization_object_post_optional_id_document, **kwargs ): - """Post Jwks # noqa: E501 + """Post Visualization Objects # noqa: E501 - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) + >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_jwk_in_document (JsonApiJwkInDocument): + workspace_id (str): + json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -23100,7 +26307,7 @@ def create_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiVisualizationObjectOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23129,30 +26336,31 @@ def create_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_visualization_object_post_optional_id_document'] = \ + json_api_visualization_object_post_optional_id_document + return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def create_entity_knowledge_recommendations( + def create_entity_workspace_color_palettes( self, workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, + json_api_workspace_color_palette_in_document, **kwargs ): - """Post Knowledge Recommendations # noqa: E501 + """Post Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -23186,7 +26394,7 @@ def create_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23217,28 +26425,31 @@ def create_entity_knowledge_recommendations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ - json_api_knowledge_recommendation_post_optional_id_document - return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.create_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def create_entity_llm_providers( + def create_entity_workspace_data_filter_settings( self, - json_api_llm_provider_in_document, + workspace_id, + json_api_workspace_data_filter_setting_in_document, **kwargs ): - """Post LLM Provider entities # noqa: E501 + """Post Settings for Workspace Data Filters # noqa: E501 - LLM Provider - connection configuration for LLM services # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) + >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) >>> result = thread.get() Args: - json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + workspace_id (str): + json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -23271,7 +26482,7 @@ def create_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23300,27 +26511,29 @@ def create_entity_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_provider_in_document'] = \ - json_api_llm_provider_in_document - return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_data_filter_setting_in_document'] = \ + json_api_workspace_data_filter_setting_in_document + return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_memory_items( + def create_entity_workspace_data_filters( self, workspace_id, - json_api_memory_item_post_optional_id_document, + json_api_workspace_data_filter_in_document, **kwargs ): - """Post Memory Items # noqa: E501 + """Post Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -23357,7 +26570,7 @@ def create_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23388,30 +26601,29 @@ def create_entity_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_memory_item_post_optional_id_document'] = \ - json_api_memory_item_post_optional_id_document - return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_data_filter_in_document'] = \ + json_api_workspace_data_filter_in_document + return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def create_entity_metrics( + def create_entity_workspace_export_templates( self, workspace_id, - json_api_metric_post_optional_id_document, + json_api_workspace_export_template_post_optional_id_document, **kwargs ): - """Post Metrics # noqa: E501 + """Post Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): + json_api_workspace_export_template_post_optional_id_document (JsonApiWorkspaceExportTemplatePostOptionalIdDocument): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -23445,7 +26657,7 @@ def create_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23476,109 +26688,30 @@ def create_entity_metrics( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) - - def create_entity_notification_channels( - self, - json_api_notification_channel_post_optional_id_document, - **kwargs - ): - """Post Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) - >>> result = thread.get() + kwargs['json_api_workspace_export_template_post_optional_id_document'] = \ + json_api_workspace_export_template_post_optional_id_document + return self.create_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): - - 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: - JsonApiNotificationChannelOutDocument - 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['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - - def create_entity_organization_settings( + def create_entity_workspace_settings( self, - json_api_organization_setting_in_document, + workspace_id, + json_api_workspace_setting_post_optional_id_document, **kwargs ): - """Post Organization Setting entities # noqa: E501 + """Post Settings for Workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) + >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): + workspace_id (str): + json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): Keyword Args: + meta_include ([str]): Include Meta objects.. [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 @@ -23611,7 +26744,7 @@ def create_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23640,30 +26773,31 @@ def create_entity_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_setting_post_optional_id_document'] = \ + json_api_workspace_setting_post_optional_id_document + return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_parameters( + def create_entity_workspace_themes( self, workspace_id, - json_api_parameter_post_optional_id_document, + json_api_workspace_theme_in_document, **kwargs ): - """Post Parameters # noqa: E501 + """Post Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_parameters(workspace_id, json_api_parameter_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_parameter_post_optional_id_document (JsonApiParameterPostOptionalIdDocument): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -23697,7 +26831,7 @@ def create_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23728,27 +26862,30 @@ def create_entity_parameters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_parameter_post_optional_id_document'] = \ - json_api_parameter_post_optional_id_document - return self.create_entity_parameters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.create_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def create_entity_themes( + def create_entity_workspaces( self, - json_api_theme_in_document, + json_api_workspace_in_document, **kwargs ): - """Post Theming # noqa: E501 + """Post Workspace entities # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) + >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) >>> result = thread.get() Args: - json_api_theme_in_document (JsonApiThemeInDocument): + json_api_workspace_in_document (JsonApiWorkspaceInDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -23781,7 +26918,7 @@ def create_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23810,31 +26947,28 @@ def create_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_in_document'] = \ + json_api_workspace_in_document + return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def create_entity_user_data_filters( + def delete_entity( self, - workspace_id, - json_api_user_data_filter_post_optional_id_document, + id, **kwargs ): - """Post User Data Filters # noqa: E501 + """Delete LLM endpoint entity (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -23867,7 +27001,7 @@ def create_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -23896,31 +27030,27 @@ def create_entity_user_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_endpoint.call_with_http_info(**kwargs) - def create_entity_user_groups( + def delete_entity_agents( self, - json_api_user_group_in_document, + id, **kwargs ): - """Post User Group entities # noqa: E501 + """Delete Agent entity # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) + >>> thread = api.delete_entity_agents(id, async_req=True) >>> result = thread.get() Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -23953,7 +27083,7 @@ def create_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -23982,27 +27112,27 @@ def create_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_agents_endpoint.call_with_http_info(**kwargs) - def create_entity_user_settings( + def delete_entity_analytical_dashboards( self, - user_id, - json_api_user_setting_in_document, + workspace_id, + object_id, **kwargs ): - """Post new user settings for the user # noqa: E501 + """Delete a Dashboard # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) + >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -24037,7 +27167,7 @@ def create_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24066,31 +27196,31 @@ def create_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def create_entity_users( + def delete_entity_api_tokens( self, - json_api_user_in_document, + user_id, + id, **kwargs ): - """Post User entities # noqa: E501 + """Delete an API Token for a user # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) + >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) >>> result = thread.get() Args: - json_api_user_in_document (JsonApiUserInDocument): + user_id (str): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -24123,7 +27253,7 @@ def create_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24152,31 +27282,31 @@ def create_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - def create_entity_visualization_objects( + def delete_entity_attribute_hierarchies( self, workspace_id, - json_api_visualization_object_post_optional_id_document, + object_id, **kwargs ): - """Post Visualization Objects # noqa: E501 + """Delete an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -24209,7 +27339,7 @@ def create_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24240,31 +27370,29 @@ def create_entity_visualization_objects( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_data_filter_settings( + def delete_entity_automations( self, workspace_id, - json_api_workspace_data_filter_setting_in_document, + object_id, **kwargs ): - """Post Settings for Workspace Data Filters # noqa: E501 + """Delete an Automation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -24297,7 +27425,7 @@ def create_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24328,31 +27456,27 @@ def create_entity_workspace_data_filter_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_data_filters( + def delete_entity_color_palettes( self, - workspace_id, - json_api_workspace_data_filter_in_document, + id, **kwargs ): - """Post Workspace Data Filters # noqa: E501 + """Delete a Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> thread = api.delete_entity_color_palettes(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -24385,7 +27509,7 @@ def create_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24414,32 +27538,28 @@ def create_entity_workspace_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_settings( + def delete_entity_csp_directives( self, - workspace_id, - json_api_workspace_setting_post_optional_id_document, + id, **kwargs ): - """Post Settings for Workspaces # noqa: E501 + """Delete CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_csp_directives(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): + id (str): Keyword Args: - meta_include ([str]): Include Meta objects.. [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 @@ -24472,7 +27592,7 @@ def create_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24501,32 +27621,29 @@ def create_entity_workspace_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def create_entity_workspaces( + def delete_entity_custom_application_settings( self, - json_api_workspace_in_document, + workspace_id, + object_id, **kwargs ): - """Post Workspace entities # noqa: E501 + """Delete a Custom Application Setting # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) + >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): + workspace_id (str): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [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 @@ -24559,7 +27676,7 @@ def create_entity_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -24588,22 +27705,23 @@ def create_entity_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity( + def delete_entity_custom_geo_collections( self, id, **kwargs ): - """Delete LLM endpoint entity (Removed) # noqa: E501 + """Delete Custom Geo Collection # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity(id, async_req=True) + >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) >>> result = thread.get() Args: @@ -24673,22 +27791,24 @@ def delete_entity( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def delete_entity_agents( + def delete_entity_custom_user_application_settings( self, + user_id, id, **kwargs ): - """Delete Agent entity # noqa: E501 + """Delete a custom application setting for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_agents(id, async_req=True) + >>> thread = api.delete_entity_custom_user_application_settings(user_id, id, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): Keyword Args: @@ -24753,22 +27873,24 @@ def delete_entity_agents( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - return self.delete_entity_agents_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_analytical_dashboards( + def delete_entity_dashboard_plugins( self, workspace_id, object_id, **kwargs ): - """Delete a Dashboard # noqa: E501 + """Delete a Plugin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -24841,24 +27963,23 @@ def delete_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def delete_entity_api_tokens( + def delete_entity_data_sources( self, - user_id, id, **kwargs ): - """Delete an API Token for a user # noqa: E501 + """Delete Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) + >>> thread = api.delete_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): Keyword Args: @@ -24923,110 +28044,22 @@ def delete_entity_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - - def delete_entity_attribute_hierarchies( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete an Attribute Hierarchy # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_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: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def delete_entity_automations( + def delete_entity_export_definitions( self, workspace_id, object_id, **kwargs ): - """Delete an Automation # noqa: E501 + """Delete an Export Definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -25099,19 +28132,19 @@ def delete_entity_automations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def delete_entity_color_palettes( + def delete_entity_export_templates( self, id, **kwargs ): - """Delete a Color Pallette # noqa: E501 + """Delete Export Template entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_color_palettes(id, async_req=True) + >>> thread = api.delete_entity_export_templates(id, async_req=True) >>> result = thread.get() Args: @@ -25181,24 +28214,25 @@ def delete_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_csp_directives( + def delete_entity_filter_contexts( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete CSP Directives # noqa: E501 + """Delete a Filter Context # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_csp_directives(id, async_req=True) + >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -25262,22 +28296,24 @@ def delete_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_application_settings( + def delete_entity_filter_views( self, workspace_id, object_id, **kwargs ): - """Delete a Custom Application Setting # noqa: E501 + """Delete Filter view # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -25350,19 +28386,19 @@ def delete_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_geo_collections( + def delete_entity_identity_providers( self, id, **kwargs ): - """Delete Custom Geo Collection # noqa: E501 + """Delete Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) + >>> thread = api.delete_entity_identity_providers(id, async_req=True) >>> result = thread.get() Args: @@ -25432,24 +28468,22 @@ def delete_entity_custom_geo_collections( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_user_application_settings( + def delete_entity_ip_allowlist_policies( self, - user_id, id, **kwargs ): - """Delete a custom application setting for a user # noqa: E501 + """Delete IpAllowlistPolicy entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_user_application_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_ip_allowlist_policies(id, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): Keyword Args: @@ -25514,110 +28548,22 @@ def delete_entity_custom_user_application_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - return self.delete_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - - def delete_entity_dashboard_plugins( - self, - workspace_id, - object_id, - **kwargs - ): - """Delete a Plugin # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_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: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def delete_entity_data_sources( + def delete_entity_jwks( self, id, **kwargs ): - """Delete Data Source entity # noqa: E501 + """Delete Jwk # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 + Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_data_sources(id, async_req=True) + >>> thread = api.delete_entity_jwks(id, async_req=True) >>> result = thread.get() Args: @@ -25687,20 +28633,20 @@ def delete_entity_data_sources( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_definitions( + def delete_entity_knowledge_recommendations( self, workspace_id, object_id, **kwargs ): - """Delete an Export Definition # noqa: E501 + """Delete a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -25773,19 +28719,19 @@ def delete_entity_export_definitions( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_templates( + def delete_entity_llm_providers( self, id, **kwargs ): - """Delete Export Template entity # noqa: E501 + """Delete LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_export_templates(id, async_req=True) + >>> thread = api.delete_entity_llm_providers(id, async_req=True) >>> result = thread.get() Args: @@ -25855,20 +28801,20 @@ def delete_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_contexts( + def delete_entity_memory_items( self, workspace_id, object_id, **kwargs ): - """Delete a Filter Context # noqa: E501 + """Delete a Memory Item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -25941,20 +28887,20 @@ def delete_entity_filter_contexts( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_views( + def delete_entity_metrics( self, workspace_id, object_id, **kwargs ): - """Delete Filter view # noqa: E501 + """Delete a Metric # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -26027,19 +28973,19 @@ def delete_entity_filter_views( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) - def delete_entity_identity_providers( + def delete_entity_notification_channels( self, id, **kwargs ): - """Delete Identity Provider # noqa: E501 + """Delete Notification Channel entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_identity_providers(id, async_req=True) + >>> thread = api.delete_entity_notification_channels(id, async_req=True) >>> result = thread.get() Args: @@ -26109,19 +29055,19 @@ def delete_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def delete_entity_ip_allowlist_policies( + def delete_entity_org_memory_items( self, id, **kwargs ): - """Delete IpAllowlistPolicy entity # noqa: E501 + """Delete an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_ip_allowlist_policies(id, async_req=True) + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) >>> result = thread.get() Args: @@ -26191,20 +29137,19 @@ def delete_entity_ip_allowlist_policies( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( + def delete_entity_organization_settings( self, id, **kwargs ): - """Delete Jwk # noqa: E501 + """Delete Organization Setting entity # noqa: E501 - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_jwks(id, async_req=True) + >>> thread = api.delete_entity_organization_settings(id, async_req=True) >>> result = thread.get() Args: @@ -26274,20 +29219,20 @@ def delete_entity_jwks( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_knowledge_recommendations( + def delete_entity_parameters( self, workspace_id, object_id, **kwargs ): - """Delete a Knowledge Recommendation # noqa: E501 + """Delete a Parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_parameters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -26360,19 +29305,19 @@ def delete_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_parameters_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_providers( + def delete_entity_themes( self, id, **kwargs ): - """Delete LLM Provider entity # noqa: E501 + """Delete Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_llm_providers(id, async_req=True) + >>> thread = api.delete_entity_themes(id, async_req=True) >>> result = thread.get() Args: @@ -26442,20 +29387,20 @@ def delete_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_memory_items( + def delete_entity_user_data_filters( self, workspace_id, object_id, **kwargs ): - """Delete a Memory Item # noqa: E501 + """Delete a User Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -26528,25 +29473,24 @@ def delete_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_metrics( + def delete_entity_user_groups( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Metric # noqa: E501 + """Delete UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_user_groups(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -26610,26 +29554,26 @@ def delete_entity_metrics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def delete_entity_notification_channels( + def delete_entity_user_settings( self, + user_id, id, **kwargs ): - """Delete Notification Channel entity # noqa: E501 + """Delete a setting for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_notification_channels(id, async_req=True) + >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): Keyword Args: @@ -26694,21 +29638,24 @@ def delete_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_organization_settings( + def delete_entity_users( self, id, **kwargs ): - """Delete Organization Setting entity # noqa: E501 + """Delete User entity # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_organization_settings(id, async_req=True) + >>> thread = api.delete_entity_users(id, async_req=True) >>> result = thread.get() Args: @@ -26778,20 +29725,20 @@ def delete_entity_organization_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) - def delete_entity_parameters( + def delete_entity_visualization_objects( self, workspace_id, object_id, **kwargs ): - """Delete a Parameter # noqa: E501 + """Delete a Visualization Object # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_parameters(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -26864,23 +29811,25 @@ def delete_entity_parameters( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_parameters_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def delete_entity_themes( + def delete_entity_workspace_color_palettes( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Theming # noqa: E501 + """Delete a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_themes(id, async_req=True) + >>> thread = api.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -26944,22 +29893,24 @@ def delete_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_data_filters( + def delete_entity_workspace_data_filter_settings( self, workspace_id, object_id, **kwargs ): - """Delete a User Data Filter # noqa: E501 + """Delete a Settings for Workspace Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27032,24 +29983,25 @@ def delete_entity_user_data_filters( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_groups( + def delete_entity_workspace_data_filters( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete UserGroup entity # noqa: E501 + """Delete a Workspace Data Filter # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_groups(id, async_req=True) + >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27113,27 +30065,29 @@ def delete_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_settings( + def delete_entity_workspace_export_templates( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Delete a setting for a user # noqa: E501 + """Delete a Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_workspace_export_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27197,28 +30151,29 @@ def delete_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_users( + def delete_entity_workspace_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete User entity # noqa: E501 + """Delete a Setting for Workspace # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_users(id, async_req=True) + >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27282,22 +30237,24 @@ def delete_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_visualization_objects( + def delete_entity_workspace_themes( self, workspace_id, object_id, **kwargs ): - """Delete a Visualization Object # noqa: E501 + """Delete a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27370,25 +30327,24 @@ def delete_entity_visualization_objects( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filter_settings( + def delete_entity_workspaces( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Settings for Workspace Data Filter # noqa: E501 + """Delete Workspace entity # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspaces(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27452,31 +30408,30 @@ def delete_entity_workspace_data_filter_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filters( + def get_all_automations_workspace_automations( self, - workspace_id, - object_id, **kwargs ): - """Delete a Workspace Data Filter # noqa: E501 + """Get all Automations across all Workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_automations_workspace_automations(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -27509,7 +30464,7 @@ def delete_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - None + JsonApiWorkspaceAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -27538,29 +30493,21 @@ def delete_entity_workspace_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_settings( + def get_all_entities( self, - workspace_id, - object_id, **kwargs ): - """Delete a Setting for Workspace # noqa: E501 + """Get all LLM endpoint entities (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27624,30 +30571,28 @@ def delete_entity_workspace_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspaces( + def get_all_entities_agents( self, - id, **kwargs ): - """Delete Workspace entity # noqa: E501 + """Get all Agent entities # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspaces(id, async_req=True) + >>> thread = api.get_all_entities_agents(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -27680,7 +30625,7 @@ def delete_entity_workspaces( async_req (bool): execute request asynchronously Returns: - None + JsonApiAgentOutList If the method is called asynchronously, returns the request thread. """ @@ -27709,29 +30654,32 @@ def delete_entity_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_agents_endpoint.call_with_http_info(**kwargs) - def get_all_automations_workspace_automations( + def get_all_entities_aggregated_facts( self, + workspace_id, **kwargs ): - """Get all Automations across all Workspaces # noqa: E501 + """Get all Aggregated Facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_automations_workspace_automations(async_req=True) + >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -27765,7 +30713,7 @@ def get_all_automations_workspace_automations( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceAutomationOutList + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -27794,23 +30742,35 @@ def get_all_automations_workspace_automations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities( + def get_all_entities_analytical_dashboards( self, + workspace_id, **kwargs ): - """Get all LLM endpoint entities (Removed) # noqa: E501 + """Get all Dashboards # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities(async_req=True) + >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -27843,7 +30803,7 @@ def get_all_entities( async_req (bool): execute request asynchronously Returns: - None + JsonApiAnalyticalDashboardOutList If the method is called asynchronously, returns the request thread. """ @@ -27872,24 +30832,28 @@ def get_all_entities( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def get_all_entities_agents( + def get_all_entities_api_tokens( self, + user_id, **kwargs ): - """Get all Agent entities # noqa: E501 + """List all api tokens for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_agents(async_req=True) + >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) >>> result = thread.get() + Args: + user_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -27926,7 +30890,7 @@ def get_all_entities_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutList + JsonApiApiTokenOutList If the method is called asynchronously, returns the request thread. """ @@ -27955,19 +30919,21 @@ def get_all_entities_agents( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_agents_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) - def get_all_entities_aggregated_facts( + def get_all_entities_attribute_hierarchies( self, workspace_id, **kwargs ): - """Get all Aggregated Facts # noqa: E501 + """Get all Attribute Hierarchies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -28014,7 +30980,7 @@ def get_all_entities_aggregated_facts( async_req (bool): execute request asynchronously Returns: - JsonApiAggregatedFactOutList + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -28045,19 +31011,19 @@ def get_all_entities_aggregated_facts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_analytical_dashboards( + def get_all_entities_attributes( self, workspace_id, **kwargs ): - """Get all Dashboards # noqa: E501 + """Get all Attributes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) + >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -28104,7 +31070,7 @@ def get_all_entities_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutList + JsonApiAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -28135,29 +31101,32 @@ def get_all_entities_analytical_dashboards( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_api_tokens( + def get_all_entities_automations( self, - user_id, + workspace_id, **kwargs ): - """List all api tokens for a user # noqa: E501 + """Get all Automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) + >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) >>> result = thread.get() Args: - user_id (str): + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -28191,7 +31160,7 @@ def get_all_entities_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutList + JsonApiAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -28220,34 +31189,28 @@ def get_all_entities_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attribute_hierarchies( + def get_all_entities_color_palettes( self, - workspace_id, **kwargs ): - """Get all Attribute Hierarchies # noqa: E501 + """Get all Color Pallettes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) + >>> thread = api.get_all_entities_color_palettes(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -28281,7 +31244,7 @@ def get_all_entities_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutList + JsonApiColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -28310,34 +31273,27 @@ def get_all_entities_attribute_hierarchies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attributes( + def get_all_entities_csp_directives( self, - workspace_id, **kwargs ): - """Get all Attributes # noqa: E501 + """Get CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) + >>> thread = api.get_all_entities_csp_directives(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -28371,7 +31327,7 @@ def get_all_entities_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutList + JsonApiCspDirectiveOutList If the method is called asynchronously, returns the request thread. """ @@ -28400,21 +31356,19 @@ def get_all_entities_attributes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) - def get_all_entities_automations( + def get_all_entities_custom_application_settings( self, workspace_id, **kwargs ): - """Get all Automations # noqa: E501 + """Get all Custom Application Settings # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -28423,7 +31377,6 @@ def get_all_entities_automations( Keyword Args: origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -28461,7 +31414,7 @@ def get_all_entities_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutList + JsonApiCustomApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -28492,18 +31445,18 @@ def get_all_entities_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_color_palettes( + def get_all_entities_custom_geo_collections( self, **kwargs ): - """Get all Color Pallettes # noqa: E501 + """Get all Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_color_palettes(async_req=True) + >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) >>> result = thread.get() @@ -28545,7 +31498,7 @@ def get_all_entities_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutList + JsonApiCustomGeoCollectionOutList If the method is called asynchronously, returns the request thread. """ @@ -28574,21 +31527,23 @@ def get_all_entities_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def get_all_entities_csp_directives( + def get_all_entities_custom_user_application_settings( self, + user_id, **kwargs ): - """Get CSP Directives # noqa: E501 + """List all custom application settings for a user # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_csp_directives(async_req=True) + >>> thread = api.get_all_entities_custom_user_application_settings(user_id, async_req=True) >>> result = thread.get() + Args: + user_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -28628,7 +31583,7 @@ def get_all_entities_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutList + JsonApiCustomUserApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -28657,19 +31612,21 @@ def get_all_entities_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_application_settings( + def get_all_entities_dashboard_plugins( self, workspace_id, **kwargs ): - """Get all Custom Application Settings # noqa: E501 + """Get all Plugins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) + >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -28678,6 +31635,7 @@ def get_all_entities_custom_application_settings( Keyword Args: origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -28715,7 +31673,7 @@ def get_all_entities_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutList + JsonApiDashboardPluginOutList If the method is called asynchronously, returns the request thread. """ @@ -28746,18 +31704,18 @@ def get_all_entities_custom_application_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_geo_collections( + def get_all_entities_data_source_identifiers( self, **kwargs ): - """Get all Custom Geo Collections # noqa: E501 + """Get all Data Source Identifiers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) + >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) >>> result = thread.get() @@ -28799,7 +31757,7 @@ def get_all_entities_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutList + JsonApiDataSourceIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -28828,23 +31786,21 @@ def get_all_entities_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_user_application_settings( + def get_all_entities_data_sources( self, - user_id, **kwargs ): - """List all custom application settings for a user # noqa: E501 + """Get Data Source entities # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_user_application_settings(user_id, async_req=True) + >>> thread = api.get_all_entities_data_sources(async_req=True) >>> result = thread.get() - Args: - user_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -28884,7 +31840,7 @@ def get_all_entities_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutList + JsonApiDataSourceOutList If the method is called asynchronously, returns the request thread. """ @@ -28913,21 +31869,19 @@ def get_all_entities_custom_user_application_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def get_all_entities_dashboard_plugins( + def get_all_entities_datasets( self, workspace_id, **kwargs ): - """Get all Plugins # noqa: E501 + """Get all Datasets # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) + >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -28974,7 +31928,7 @@ def get_all_entities_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutList + JsonApiDatasetOutList If the method is called asynchronously, returns the request thread. """ @@ -29005,18 +31959,19 @@ def get_all_entities_dashboard_plugins( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_source_identifiers( + def get_all_entities_entitlements( self, **kwargs ): - """Get all Data Source Identifiers # noqa: E501 + """Get Entitlements # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) + >>> thread = api.get_all_entities_entitlements(async_req=True) >>> result = thread.get() @@ -29058,7 +32013,7 @@ def get_all_entities_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutList + JsonApiEntitlementOutList If the method is called asynchronously, returns the request thread. """ @@ -29087,27 +32042,32 @@ def get_all_entities_data_source_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_sources( + def get_all_entities_export_definitions( self, + workspace_id, **kwargs ): - """Get Data Source entities # noqa: E501 + """Get all Export Definitions # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_sources(async_req=True) + >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -29141,7 +32101,91 @@ def get_all_entities_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutList + JsonApiExportDefinitionOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_export_templates( + self, + **kwargs + ): + """GET all Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_export_templates(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -29170,19 +32214,19 @@ def get_all_entities_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_datasets( + def get_all_entities_facts( self, workspace_id, **kwargs ): - """Get all Datasets # noqa: E501 + """Get all Facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) + >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -29229,7 +32273,7 @@ def get_all_entities_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutList + JsonApiFactOutList If the method is called asynchronously, returns the request thread. """ @@ -29260,27 +32304,32 @@ def get_all_entities_datasets( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_entitlements( + def get_all_entities_filter_contexts( self, + workspace_id, **kwargs ): - """Get Entitlements # noqa: E501 + """Get all Filter Context # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_entitlements(async_req=True) + >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -29314,7 +32363,7 @@ def get_all_entities_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutList + JsonApiFilterContextOutList If the method is called asynchronously, returns the request thread. """ @@ -29343,19 +32392,21 @@ def get_all_entities_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_definitions( + def get_all_entities_filter_views( self, workspace_id, **kwargs ): - """Get all Export Definitions # noqa: E501 + """Get all Filter views # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) + >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -29402,7 +32453,7 @@ def get_all_entities_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutList + JsonApiFilterViewOutList If the method is called asynchronously, returns the request thread. """ @@ -29433,26 +32484,31 @@ def get_all_entities_export_definitions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( + def get_all_entities_fiscal_calendars( self, + workspace_id, **kwargs ): - """GET all Export Template entities # noqa: E501 + """Get all Fiscal Calendars # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_templates(async_req=True) + >>> thread = api.get_all_entities_fiscal_calendars(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -29486,7 +32542,7 @@ def get_all_entities_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutList + JsonApiFiscalCalendarOutList If the method is called asynchronously, returns the request thread. """ @@ -29515,32 +32571,111 @@ def get_all_entities_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_fiscal_calendars_endpoint.call_with_http_info(**kwargs) - def get_all_entities_facts( + def get_all_entities_identity_providers( self, - workspace_id, **kwargs ): - """Get all Facts # noqa: E501 + """Get all Identity Providers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_identity_providers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiIdentityProviderOutList + 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.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_ip_allowlist_policies( + self, + **kwargs + ): + """Get all IpAllowlistPolicy entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_ip_allowlist_policies(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -29574,7 +32709,7 @@ def get_all_entities_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutList + JsonApiIpAllowlistPolicyOutList If the method is called asynchronously, returns the request thread. """ @@ -29603,21 +32738,102 @@ def get_all_entities_facts( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_contexts( + def get_all_entities_jwks( + self, + **kwargs + ): + """Get all Jwks # noqa: E501 + + Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_jwks(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiJwkOutList + 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.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_knowledge_recommendations( self, workspace_id, **kwargs ): - """Get all Filter Context # noqa: E501 + """Get all Knowledge Recommendations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -29664,7 +32880,7 @@ def get_all_entities_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutList + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -29695,19 +32911,19 @@ def get_all_entities_filter_contexts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_views( + def get_all_entities_labels( self, workspace_id, **kwargs ): - """Get all Filter views # noqa: E501 + """Get all Labels # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) + >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -29754,7 +32970,7 @@ def get_all_entities_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutList + JsonApiLabelOutList If the method is called asynchronously, returns the request thread. """ @@ -29785,18 +33001,18 @@ def get_all_entities_filter_views( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_filter_views_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_identity_providers( + def get_all_entities_llm_providers( self, **kwargs ): - """Get all Identity Providers # noqa: E501 + """Get all LLM Provider entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_identity_providers(async_req=True) + >>> thread = api.get_all_entities_llm_providers(async_req=True) >>> result = thread.get() @@ -29838,7 +33054,7 @@ def get_all_entities_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutList + JsonApiLlmProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -29867,27 +33083,32 @@ def get_all_entities_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_ip_allowlist_policies( + def get_all_entities_memory_items( self, + workspace_id, **kwargs ): - """Get all IpAllowlistPolicy entities # noqa: E501 + """Get all Memory Items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_ip_allowlist_policies(async_req=True) + >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -29921,90 +33142,7 @@ def get_all_entities_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutList - 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.get_all_entities_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_jwks( - self, - **kwargs - ): - """Get all Jwks # noqa: E501 - - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_jwks(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [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: - JsonApiJwkOutList + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -30033,19 +33171,21 @@ def get_all_entities_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def get_all_entities_knowledge_recommendations( + def get_all_entities_metrics( self, workspace_id, **kwargs ): - """Get all Knowledge Recommendations # noqa: E501 + """Get all Metrics # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -30092,7 +33232,7 @@ def get_all_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiMetricOutList If the method is called asynchronously, returns the request thread. """ @@ -30123,32 +33263,26 @@ def get_all_entities_knowledge_recommendations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) - def get_all_entities_labels( + def get_all_entities_notification_channel_identifiers( self, - workspace_id, **kwargs ): - """Get all Labels # noqa: E501 + """Get all Notification Channel Identifier entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) + >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30182,7 +33316,7 @@ def get_all_entities_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutList + JsonApiNotificationChannelIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -30211,20 +33345,18 @@ def get_all_entities_labels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_providers( + def get_all_entities_notification_channels( self, **kwargs ): - """Get all LLM Provider entities # noqa: E501 + """Get all Notification Channel entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_llm_providers(async_req=True) + >>> thread = api.get_all_entities_notification_channels(async_req=True) >>> result = thread.get() @@ -30266,7 +33398,7 @@ def get_all_entities_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutList + JsonApiNotificationChannelOutList If the method is called asynchronously, returns the request thread. """ @@ -30295,32 +33427,27 @@ def get_all_entities_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_memory_items( + def get_all_entities_org_memory_items( self, - workspace_id, **kwargs ): - """Get all Memory Items # noqa: E501 + """Get all organization Memory Item entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) + >>> thread = api.get_all_entities_org_memory_items(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30354,7 +33481,7 @@ def get_all_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiOrgMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -30383,34 +33510,26 @@ def get_all_entities_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) - def get_all_entities_metrics( + def get_all_entities_organization_settings( self, - workspace_id, **kwargs ): - """Get all Metrics # noqa: E501 + """Get Organization Setting entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) + >>> thread = api.get_all_entities_organization_settings(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30444,7 +33563,7 @@ def get_all_entities_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutList + JsonApiOrganizationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -30473,28 +33592,32 @@ def get_all_entities_metrics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channel_identifiers( + def get_all_entities_parameters( self, + workspace_id, **kwargs ): - """Get all Notification Channel Identifier entities # noqa: E501 + """Get all Parameters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) + >>> thread = api.get_all_entities_parameters(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30528,7 +33651,7 @@ def get_all_entities_notification_channel_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelIdentifierOutList + JsonApiParameterOutList If the method is called asynchronously, returns the request thread. """ @@ -30557,18 +33680,20 @@ def get_all_entities_notification_channel_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_parameters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_notification_channels( + def get_all_entities_themes( self, **kwargs ): - """Get all Notification Channel entities # noqa: E501 + """Get all Theming entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_notification_channels(async_req=True) + >>> thread = api.get_all_entities_themes(async_req=True) >>> result = thread.get() @@ -30610,7 +33735,7 @@ def get_all_entities_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutList + JsonApiThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -30639,26 +33764,32 @@ def get_all_entities_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_organization_settings( + def get_all_entities_user_data_filters( self, + workspace_id, **kwargs ): - """Get Organization Setting entities # noqa: E501 + """Get all User Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_organization_settings(async_req=True) + >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30692,7 +33823,7 @@ def get_all_entities_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutList + JsonApiUserDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -30721,32 +33852,30 @@ def get_all_entities_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_parameters( + def get_all_entities_user_groups( self, - workspace_id, **kwargs ): - """Get all Parameters # noqa: E501 + """Get UserGroup entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_parameters(workspace_id, async_req=True) + >>> thread = api.get_all_entities_user_groups(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30780,7 +33909,7 @@ def get_all_entities_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutList + JsonApiUserGroupOutList If the method is called asynchronously, returns the request thread. """ @@ -30809,20 +33938,19 @@ def get_all_entities_parameters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_parameters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) - def get_all_entities_themes( + def get_all_entities_user_identifiers( self, **kwargs ): - """Get all Theming entities # noqa: E501 + """Get UserIdentifier entities # noqa: E501 + UserIdentifier - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_themes(async_req=True) + >>> thread = api.get_all_entities_user_identifiers(async_req=True) >>> result = thread.get() @@ -30864,7 +33992,7 @@ def get_all_entities_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutList + JsonApiUserIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -30893,32 +34021,29 @@ def get_all_entities_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_data_filters( + def get_all_entities_user_settings( self, - workspace_id, + user_id, **kwargs ): - """Get all User Data Filters # noqa: E501 + """List all settings for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) + >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + user_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30952,7 +34077,7 @@ def get_all_entities_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutList + JsonApiUserSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -30981,21 +34106,21 @@ def get_all_entities_user_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_groups( + def get_all_entities_users( self, **kwargs ): - """Get UserGroup entities # noqa: E501 + """Get User entities # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_groups(async_req=True) + >>> thread = api.get_all_entities_users(async_req=True) >>> result = thread.get() @@ -31038,7 +34163,7 @@ def get_all_entities_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutList + JsonApiUserOutList If the method is called asynchronously, returns the request thread. """ @@ -31067,27 +34192,32 @@ def get_all_entities_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_identifiers( + def get_all_entities_visualization_objects( self, + workspace_id, **kwargs ): - """Get UserIdentifier entities # noqa: E501 + """Get all Visualization Objects # noqa: E501 - UserIdentifier - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_identifiers(async_req=True) + >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -31121,7 +34251,7 @@ def get_all_entities_user_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiUserIdentifierOutList + JsonApiVisualizationObjectOutList If the method is called asynchronously, returns the request thread. """ @@ -31150,29 +34280,33 @@ def get_all_entities_user_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_settings( + def get_all_entities_workspace_color_palettes( self, - user_id, + workspace_id, **kwargs ): - """List all settings for a user # noqa: E501 + """Get all Workspace Color Palettes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) + >>> thread = api.get_all_entities_workspace_color_palettes(workspace_id, async_req=True) >>> result = thread.get() Args: - user_id (str): + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -31206,7 +34340,7 @@ def get_all_entities_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutList + JsonApiWorkspaceColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -31235,30 +34369,34 @@ def get_all_entities_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_users( + def get_all_entities_workspace_data_filter_settings( self, + workspace_id, **kwargs ): - """Get User entities # noqa: E501 + """Get all Settings for Workspace Data Filters # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_users(async_req=True) + >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -31292,7 +34430,7 @@ def get_all_entities_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutList + JsonApiWorkspaceDataFilterSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -31321,19 +34459,21 @@ def get_all_entities_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_visualization_objects( + def get_all_entities_workspace_data_filters( self, workspace_id, **kwargs ): - """Get all Visualization Objects # noqa: E501 + """Get all Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31380,7 +34520,7 @@ def get_all_entities_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutList + JsonApiWorkspaceDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -31411,19 +34551,19 @@ def get_all_entities_visualization_objects( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filter_settings( + def get_all_entities_workspace_export_templates( self, workspace_id, **kwargs ): - """Get all Settings for Workspace Data Filters # noqa: E501 + """Get all Workspace Export Templates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_export_templates(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31432,7 +34572,6 @@ def get_all_entities_workspace_data_filter_settings( Keyword Args: origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -31470,7 +34609,7 @@ def get_all_entities_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutList + JsonApiWorkspaceExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -31501,19 +34640,19 @@ def get_all_entities_workspace_data_filter_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filters( + def get_all_entities_workspace_settings( self, workspace_id, **kwargs ): - """Get all Workspace Data Filters # noqa: E501 + """Get all Setting for Workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31522,7 +34661,6 @@ def get_all_entities_workspace_data_filters( Keyword Args: origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -31560,7 +34698,7 @@ def get_all_entities_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutList + JsonApiWorkspaceSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -31591,19 +34729,19 @@ def get_all_entities_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_settings( + def get_all_entities_workspace_themes( self, workspace_id, **kwargs ): - """Get all Setting for Workspaces # noqa: E501 + """Get all Workspace Themes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_themes(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31649,7 +34787,7 @@ def get_all_entities_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutList + JsonApiWorkspaceThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -31680,7 +34818,7 @@ def get_all_entities_workspace_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_themes_endpoint.call_with_http_info(**kwargs) def get_all_entities_workspaces( self, @@ -34010,6 +37148,94 @@ def get_entity_filter_views( object_id return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + def get_entity_fiscal_calendars( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Fiscal Calendar # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_fiscal_calendars(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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: + JsonApiFiscalCalendarOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_fiscal_calendars_endpoint.call_with_http_info(**kwargs) + def get_entity_identity_providers( self, id, @@ -34870,6 +38096,90 @@ def get_entity_notification_channels( id return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + def get_entity_org_memory_items( + self, + id, + **kwargs + ): + """Get an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + def get_entity_organization_settings( self, id, @@ -35466,30 +38776,294 @@ def get_entity_user_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + + def get_entity_user_settings( + self, + user_id, + id, + **kwargs + ): + """Get a setting for a user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiUserSettingOutDocument + 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['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + + def get_entity_users( + self, + id, + **kwargs + ): + """Get User entity # noqa: E501 + + User - represents entity interacting with platform # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_users(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiUserOutDocument + 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['id'] = \ + id + return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + + def get_entity_visualization_objects( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiVisualizationObjectOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_entity_user_settings( + def get_entity_workspace_color_palettes( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Get a setting for a user # noqa: E501 + """Get a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.get_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -35522,7 +39096,7 @@ def get_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35551,32 +39125,35 @@ def get_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_entity_users( + def get_entity_workspace_data_filter_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Get User entity # noqa: E501 + """Get a Setting for Workspace Data Filter # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_users(id, async_req=True) + >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -35609,7 +39186,7 @@ def get_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35638,22 +39215,24 @@ def get_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_visualization_objects( + def get_entity_workspace_data_filters( self, workspace_id, object_id, **kwargs ): - """Get a Visualization Object # noqa: E501 + """Get a Workspace Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35697,7 +39276,7 @@ def get_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35730,20 +39309,20 @@ def get_entity_visualization_objects( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_data_filter_settings( + def get_entity_workspace_export_templates( self, workspace_id, object_id, **kwargs ): - """Get a Setting for Workspace Data Filter # noqa: E501 + """Get a Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_export_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35752,7 +39331,6 @@ def get_entity_workspace_data_filter_settings( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status @@ -35787,7 +39365,7 @@ def get_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35820,20 +39398,20 @@ def get_entity_workspace_data_filter_settings( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_data_filters( + def get_entity_workspace_settings( self, workspace_id, object_id, **kwargs ): - """Get a Workspace Data Filter # noqa: E501 + """Get a Setting for Workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35842,7 +39420,6 @@ def get_entity_workspace_data_filters( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status @@ -35877,7 +39454,7 @@ def get_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35910,20 +39487,20 @@ def get_entity_workspace_data_filters( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_settings( + def get_entity_workspace_themes( self, workspace_id, object_id, **kwargs ): - """Get a Setting for Workspace # noqa: E501 + """Get a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35966,7 +39543,7 @@ def get_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35999,7 +39576,7 @@ def get_entity_workspace_settings( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) def get_entity_workspaces( self, @@ -38589,6 +42166,94 @@ def patch_entity_notification_channels( json_api_notification_channel_patch_document return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + def patch_entity_org_memory_items( + self, + id, + json_api_org_memory_item_patch_document, + **kwargs + ): + """Patch an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + kwargs['json_api_org_memory_item_patch_document'] = \ + json_api_org_memory_item_patch_document + return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + def patch_entity_organization_settings( self, id, @@ -39207,35 +42872,126 @@ def patch_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_patch_document'] = \ - json_api_user_patch_document - return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_user_patch_document'] = \ + json_api_user_patch_document + return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) + + def patch_entity_visualization_objects( + self, + workspace_id, + object_id, + json_api_visualization_object_patch_document, + **kwargs + ): + """Patch a Visualization Object # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiVisualizationObjectOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_visualization_object_patch_document'] = \ + json_api_visualization_object_patch_document + return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def patch_entity_visualization_objects( + def patch_entity_workspace_color_palettes( self, workspace_id, object_id, - json_api_visualization_object_patch_document, + json_api_workspace_color_palette_patch_document, **kwargs ): - """Patch a Visualization Object # noqa: E501 + """Patch a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): + json_api_workspace_color_palette_patch_document (JsonApiWorkspaceColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -39268,7 +43024,7 @@ def patch_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39301,9 +43057,9 @@ def patch_entity_visualization_objects( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_color_palette_patch_document'] = \ + json_api_workspace_color_palette_patch_document + return self.patch_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) def patch_entity_workspace_data_filter_settings( self, @@ -39489,6 +43245,97 @@ def patch_entity_workspace_data_filters( json_api_workspace_data_filter_patch_document return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + def patch_entity_workspace_export_templates( + self, + workspace_id, + object_id, + json_api_workspace_export_template_patch_document, + **kwargs + ): + """Patch a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_export_template_patch_document (JsonApiWorkspaceExportTemplatePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_patch_document'] = \ + json_api_workspace_export_template_patch_document + return self.patch_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + def patch_entity_workspace_settings( self, workspace_id, @@ -39580,6 +43427,97 @@ def patch_entity_workspace_settings( json_api_workspace_setting_patch_document return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + def patch_entity_workspace_themes( + self, + workspace_id, + object_id, + json_api_workspace_theme_patch_document, + **kwargs + ): + """Patch a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_theme_patch_document (JsonApiWorkspaceThemePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceThemeOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_theme_patch_document'] = \ + json_api_workspace_theme_patch_document + return self.patch_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + def patch_entity_workspaces( self, id, @@ -40426,7 +44364,95 @@ def search_entities_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutList + JsonApiDatasetOutList + 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_datasets_endpoint.call_with_http_info(**kwargs) + + def search_entities_export_definitions( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # 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_export_definitions(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: + JsonApiExportDefinitionOutList If the method is called asynchronously, returns the request thread. """ @@ -40459,9 +44485,9 @@ def search_entities_datasets( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) + return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - def search_entities_export_definitions( + def search_entities_facts( self, workspace_id, entity_search_body, @@ -40472,7 +44498,7 @@ def search_entities_export_definitions( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_export_definitions(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40514,7 +44540,7 @@ def search_entities_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutList + JsonApiFactOutList If the method is called asynchronously, returns the request thread. """ @@ -40547,9 +44573,9 @@ def search_entities_export_definitions( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) - def search_entities_facts( + def search_entities_filter_contexts( self, workspace_id, entity_search_body, @@ -40560,7 +44586,7 @@ def search_entities_facts( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40602,7 +44628,7 @@ def search_entities_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutList + JsonApiFilterContextOutList If the method is called asynchronously, returns the request thread. """ @@ -40635,9 +44661,9 @@ def search_entities_facts( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) + return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - def search_entities_filter_contexts( + def search_entities_filter_views( self, workspace_id, entity_search_body, @@ -40648,7 +44674,7 @@ def search_entities_filter_contexts( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40690,7 +44716,7 @@ def search_entities_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutList + JsonApiFilterViewOutList If the method is called asynchronously, returns the request thread. """ @@ -40723,9 +44749,9 @@ def search_entities_filter_contexts( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) - def search_entities_filter_views( + def search_entities_knowledge_recommendations( self, workspace_id, entity_search_body, @@ -40736,7 +44762,7 @@ def search_entities_filter_views( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40778,7 +44804,7 @@ def search_entities_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutList + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -40811,9 +44837,9 @@ def search_entities_filter_views( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) + return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def search_entities_knowledge_recommendations( + def search_entities_labels( self, workspace_id, entity_search_body, @@ -40824,7 +44850,7 @@ def search_entities_knowledge_recommendations( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40866,7 +44892,7 @@ def search_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiLabelOutList If the method is called asynchronously, returns the request thread. """ @@ -40899,9 +44925,9 @@ def search_entities_knowledge_recommendations( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) - def search_entities_labels( + def search_entities_memory_items( self, workspace_id, entity_search_body, @@ -40912,7 +44938,7 @@ def search_entities_labels( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -40954,7 +44980,7 @@ def search_entities_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutList + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -40987,9 +45013,9 @@ def search_entities_labels( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def search_entities_memory_items( + def search_entities_metrics( self, workspace_id, entity_search_body, @@ -41000,7 +45026,7 @@ def search_entities_memory_items( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41042,7 +45068,7 @@ def search_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiMetricOutList If the method is called asynchronously, returns the request thread. """ @@ -41075,9 +45101,9 @@ def search_entities_memory_items( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) + return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) - def search_entities_metrics( + def search_entities_parameters( self, workspace_id, entity_search_body, @@ -41088,7 +45114,7 @@ def search_entities_metrics( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_parameters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41130,7 +45156,7 @@ def search_entities_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutList + JsonApiParameterOutList If the method is called asynchronously, returns the request thread. """ @@ -41163,9 +45189,9 @@ def search_entities_metrics( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) + return self.search_entities_parameters_endpoint.call_with_http_info(**kwargs) - def search_entities_parameters( + def search_entities_user_data_filters( self, workspace_id, entity_search_body, @@ -41176,7 +45202,7 @@ def search_entities_parameters( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_parameters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41218,7 +45244,7 @@ def search_entities_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutList + JsonApiUserDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -41251,9 +45277,9 @@ def search_entities_parameters( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_parameters_endpoint.call_with_http_info(**kwargs) + return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - def search_entities_user_data_filters( + def search_entities_visualization_objects( self, workspace_id, entity_search_body, @@ -41264,7 +45290,7 @@ def search_entities_user_data_filters( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41306,7 +45332,7 @@ def search_entities_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutList + JsonApiVisualizationObjectOutList If the method is called asynchronously, returns the request thread. """ @@ -41339,9 +45365,9 @@ def search_entities_user_data_filters( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - def search_entities_visualization_objects( + def search_entities_workspace_data_filter_settings( self, workspace_id, entity_search_body, @@ -41352,7 +45378,7 @@ def search_entities_visualization_objects( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41394,7 +45420,7 @@ def search_entities_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutList + JsonApiWorkspaceDataFilterSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -41427,9 +45453,9 @@ def search_entities_visualization_objects( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_data_filter_settings( + def search_entities_workspace_data_filters( self, workspace_id, entity_search_body, @@ -41440,7 +45466,7 @@ def search_entities_workspace_data_filter_settings( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41482,7 +45508,7 @@ def search_entities_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutList + JsonApiWorkspaceDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -41515,9 +45541,9 @@ def search_entities_workspace_data_filter_settings( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_data_filters( + def search_entities_workspace_settings( self, workspace_id, entity_search_body, @@ -41528,7 +45554,7 @@ def search_entities_workspace_data_filters( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_settings(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -41570,7 +45596,7 @@ def search_entities_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutList + JsonApiWorkspaceSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -41603,29 +45629,26 @@ def search_entities_workspace_data_filters( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_settings( + def update_entity( self, - workspace_id, - entity_search_body, + id, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """PUT LLM endpoint entity (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # 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_workspace_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.update_entity(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + id (str): 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 @@ -41658,7 +45681,7 @@ def search_entities_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutList + None If the method is called asynchronously, returns the request thread. """ @@ -41687,30 +45710,31 @@ def search_entities_workspace_settings( '_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_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.update_entity_endpoint.call_with_http_info(**kwargs) - def update_entity( + def update_entity_agents( self, id, + json_api_agent_in_document, **kwargs ): - """PUT LLM endpoint entity (Removed) # noqa: E501 + """Put Agent entity # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity(id, async_req=True) + >>> thread = api.update_entity_agents(id, json_api_agent_in_document, async_req=True) >>> result = thread.get() Args: id (str): + json_api_agent_in_document (JsonApiAgentInDocument): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -41743,7 +45767,7 @@ def update_entity( async_req (bool): execute request asynchronously Returns: - None + JsonApiAgentOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41774,25 +45798,121 @@ def update_entity( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.update_entity_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_agent_in_document'] = \ + json_api_agent_in_document + return self.update_entity_agents_endpoint.call_with_http_info(**kwargs) - def update_entity_agents( + def update_entity_analytical_dashboards( self, - id, - json_api_agent_in_document, + workspace_id, + object_id, + json_api_analytical_dashboard_in_document, **kwargs ): - """Put Agent entity # noqa: E501 + """Put Dashboards # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_agents(id, json_api_agent_in_document, async_req=True) + >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_agent_in_document (JsonApiAgentInDocument): + workspace_id (str): + object_id (str): + json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiAnalyticalDashboardOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_analytical_dashboard_in_document'] = \ + json_api_analytical_dashboard_in_document + return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def update_entity_attribute_hierarchies( + self, + workspace_id, + object_id, + json_api_attribute_hierarchy_in_document, + **kwargs + ): + """Put an Attribute Hierarchy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -41829,7 +45949,7 @@ def update_entity_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutDocument + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41858,31 +45978,33 @@ def update_entity_agents( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_agent_in_document'] = \ - json_api_agent_in_document - return self.update_entity_agents_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_attribute_hierarchy_in_document'] = \ + json_api_attribute_hierarchy_in_document + return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def update_entity_analytical_dashboards( + def update_entity_automations( self, workspace_id, object_id, - json_api_analytical_dashboard_in_document, + json_api_automation_in_document, **kwargs ): - """Put Dashboards # noqa: E501 + """Put an Automation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) + >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): + json_api_automation_in_document (JsonApiAutomationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -41919,7 +46041,7 @@ def update_entity_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutDocument + JsonApiAutomationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41952,33 +46074,30 @@ def update_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_automation_in_document'] = \ + json_api_automation_in_document + return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) - def update_entity_attribute_hierarchies( + def update_entity_color_palettes( self, - workspace_id, - object_id, - json_api_attribute_hierarchy_in_document, + id, + json_api_color_palette_in_document, **kwargs ): - """Put an Attribute Hierarchy # noqa: E501 + """Put Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): + id (str): + json_api_color_palette_in_document (JsonApiColorPaletteInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42011,7 +46130,7 @@ def update_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42040,37 +46159,32 @@ def update_entity_attribute_hierarchies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_color_palette_in_document'] = \ + json_api_color_palette_in_document + return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def update_entity_automations( + def update_entity_cookie_security_configurations( self, - workspace_id, - object_id, - json_api_automation_in_document, + id, + json_api_cookie_security_configuration_in_document, **kwargs ): - """Put an Automation # noqa: E501 + """Put CookieSecurityConfiguration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) + >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): + id (str): + json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42103,7 +46217,7 @@ def update_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiCookieSecurityConfigurationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42132,31 +46246,30 @@ def update_entity_automations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_cookie_security_configuration_in_document'] = \ + json_api_cookie_security_configuration_in_document + return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - def update_entity_color_palettes( + def update_entity_csp_directives( self, id, - json_api_color_palette_in_document, + json_api_csp_directive_in_document, **kwargs ): - """Put Color Pallette # noqa: E501 + """Put CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) + >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): + json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42192,7 +46305,7 @@ def update_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42223,27 +46336,118 @@ def update_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_csp_directive_in_document'] = \ + json_api_csp_directive_in_document + return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def update_entity_cookie_security_configurations( + def update_entity_custom_application_settings( + self, + workspace_id, + object_id, + json_api_custom_application_setting_in_document, + **kwargs + ): + """Put a Custom Application Setting # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiCustomApplicationSettingOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_custom_application_setting_in_document'] = \ + json_api_custom_application_setting_in_document + return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + + def update_entity_custom_geo_collections( self, id, - json_api_cookie_security_configuration_in_document, + json_api_custom_geo_collection_in_document, **kwargs ): - """Put CookieSecurityConfiguration # noqa: E501 + """Put Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) + >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): + json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42279,7 +46483,7 @@ def update_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiCustomGeoCollectionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42310,28 +46514,29 @@ def update_entity_cookie_security_configurations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_custom_geo_collection_in_document'] = \ + json_api_custom_geo_collection_in_document + return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def update_entity_csp_directives( + def update_entity_custom_user_application_settings( self, + user_id, id, - json_api_csp_directive_in_document, + json_api_custom_user_application_setting_in_document, **kwargs ): - """Put CSP Directives # noqa: E501 + """Put a custom application setting for the user # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) + >>> thread = api.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): + json_api_custom_user_application_setting_in_document (JsonApiCustomUserApplicationSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42367,7 +46572,7 @@ def update_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiCustomUserApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42396,34 +46601,37 @@ def update_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_custom_user_application_setting_in_document'] = \ + json_api_custom_user_application_setting_in_document + return self.update_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_application_settings( + def update_entity_dashboard_plugins( self, workspace_id, object_id, - json_api_custom_application_setting_in_document, + json_api_dashboard_plugin_in_document, **kwargs ): - """Put a Custom Application Setting # noqa: E501 + """Put a Plugin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) + >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): + json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42456,7 +46664,7 @@ def update_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiDashboardPluginOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42489,27 +46697,28 @@ def update_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_dashboard_plugin_in_document'] = \ + json_api_dashboard_plugin_in_document + return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_geo_collections( + def update_entity_data_sources( self, id, - json_api_custom_geo_collection_in_document, + json_api_data_source_in_document, **kwargs ): - """Put Custom Geo Collection # noqa: E501 + """Put Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) + >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + json_api_data_source_in_document (JsonApiDataSourceInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42545,7 +46754,7 @@ def update_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42576,29 +46785,119 @@ def update_entity_custom_geo_collections( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_user_application_settings( + def update_entity_export_definitions( + self, + workspace_id, + object_id, + json_api_export_definition_in_document, + **kwargs + ): + """Put an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiExportDefinitionOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_export_definition_in_document'] = \ + json_api_export_definition_in_document + return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def update_entity_export_templates( self, - user_id, id, - json_api_custom_user_application_setting_in_document, + json_api_export_template_in_document, **kwargs ): - """Put a custom application setting for the user # noqa: E501 + """PUT Export Template entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, async_req=True) + >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): - json_api_custom_user_application_setting_in_document (JsonApiCustomUserApplicationSettingInDocument): + json_api_export_template_in_document (JsonApiExportTemplateInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42634,7 +46933,7 @@ def update_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42663,33 +46962,31 @@ def update_entity_custom_user_application_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - kwargs['json_api_custom_user_application_setting_in_document'] = \ - json_api_custom_user_application_setting_in_document - return self.update_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_export_template_in_document'] = \ + json_api_export_template_in_document + return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def update_entity_dashboard_plugins( + def update_entity_filter_contexts( self, workspace_id, object_id, - json_api_dashboard_plugin_in_document, + json_api_filter_context_in_document, **kwargs ): - """Put a Plugin # noqa: E501 + """Put a Filter Context # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) + >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): + json_api_filter_context_in_document (JsonApiFilterContextInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42726,7 +47023,7 @@ def update_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiFilterContextOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42759,31 +47056,33 @@ def update_entity_dashboard_plugins( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_filter_context_in_document'] = \ + json_api_filter_context_in_document + return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def update_entity_data_sources( + def update_entity_filter_views( self, - id, - json_api_data_source_in_document, + workspace_id, + object_id, + json_api_filter_view_in_document, **kwargs ): - """Put Data Source entity # noqa: E501 + """Put Filter views # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) + >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): + workspace_id (str): + object_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42816,7 +47115,7 @@ def update_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiFilterViewOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42845,35 +47144,34 @@ def update_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def update_entity_export_definitions( + def update_entity_identity_providers( self, - workspace_id, - object_id, - json_api_export_definition_in_document, + id, + json_api_identity_provider_in_document, **kwargs ): - """Put an Export Definition # noqa: E501 + """Put Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): + id (str): + json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42906,7 +47204,7 @@ def update_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42935,34 +47233,33 @@ def update_entity_export_definitions( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_identity_provider_in_document'] = \ + json_api_identity_provider_in_document + return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def update_entity_export_templates( + def update_entity_ip_allowlist_policies( self, id, - json_api_export_template_in_document, + json_api_ip_allowlist_policy_in_document, **kwargs ): - """PUT Export Template entity # noqa: E501 + """Put IpAllowlistPolicy entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) + >>> thread = api.update_entity_ip_allowlist_policies(id, json_api_ip_allowlist_policy_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_export_template_in_document (JsonApiExportTemplateInDocument): + json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -42995,7 +47292,7 @@ def update_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiIpAllowlistPolicyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43026,33 +47323,31 @@ def update_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_export_template_in_document'] = \ - json_api_export_template_in_document - return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_ip_allowlist_policy_in_document'] = \ + json_api_ip_allowlist_policy_in_document + return self.update_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_contexts( + def update_entity_jwks( self, - workspace_id, - object_id, - json_api_filter_context_in_document, + id, + json_api_jwk_in_document, **kwargs ): - """Put a Filter Context # noqa: E501 + """Put Jwk # noqa: E501 + Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) + >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): + id (str): + json_api_jwk_in_document (JsonApiJwkInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43085,7 +47380,7 @@ def update_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiJwkOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43114,33 +47409,31 @@ def update_entity_filter_contexts( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_views( + def update_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_filter_view_in_document, + json_api_knowledge_recommendation_in_document, **kwargs ): - """Put Filter views # noqa: E501 + """Put a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) + >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): + json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43177,7 +47470,7 @@ def update_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43210,27 +47503,27 @@ def update_entity_filter_views( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_in_document'] = \ + json_api_knowledge_recommendation_in_document + return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_identity_providers( + def update_entity_llm_providers( self, id, - json_api_identity_provider_in_document, + json_api_llm_provider_in_document, **kwargs ): - """Put Identity Provider # noqa: E501 + """PUT LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) + >>> thread = api.update_entity_llm_providers(id, json_api_llm_provider_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43266,7 +47559,7 @@ def update_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43297,27 +47590,29 @@ def update_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_llm_provider_in_document'] = \ + json_api_llm_provider_in_document + return self.update_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def update_entity_ip_allowlist_policies( + def update_entity_memory_items( self, - id, - json_api_ip_allowlist_policy_in_document, + workspace_id, + object_id, + json_api_memory_item_in_document, **kwargs ): - """Put IpAllowlistPolicy entity # noqa: E501 + """Put a Memory Item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_ip_allowlist_policies(id, json_api_ip_allowlist_policy_in_document, async_req=True) + >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + workspace_id (str): + object_id (str): + json_api_memory_item_in_document (JsonApiMemoryItemInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43354,7 +47649,7 @@ def update_entity_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43383,33 +47678,37 @@ def update_entity_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_ip_allowlist_policy_in_document'] = \ - json_api_ip_allowlist_policy_in_document - return self.update_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_memory_item_in_document'] = \ + json_api_memory_item_in_document + return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_jwks( + def update_entity_metrics( self, - id, - json_api_jwk_in_document, + workspace_id, + object_id, + json_api_metric_in_document, **kwargs ): - """Put Jwk # noqa: E501 + """Put a Metric # noqa: E501 - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) + >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): + workspace_id (str): + object_id (str): + json_api_metric_in_document (JsonApiMetricInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43442,7 +47741,7 @@ def update_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiMetricOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43471,35 +47770,34 @@ def update_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_metric_in_document'] = \ + json_api_metric_in_document + return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) - def update_entity_knowledge_recommendations( + def update_entity_notification_channels( self, - workspace_id, - object_id, - json_api_knowledge_recommendation_in_document, + id, + json_api_notification_channel_in_document, **kwargs ): - """Put a Knowledge Recommendation # noqa: E501 + """Put Notification Channel entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) + >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): + id (str): + json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43532,7 +47830,7 @@ def update_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43561,34 +47859,33 @@ def update_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_knowledge_recommendation_in_document'] = \ - json_api_knowledge_recommendation_in_document - return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_notification_channel_in_document'] = \ + json_api_notification_channel_in_document + return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def update_entity_llm_providers( + def update_entity_org_memory_items( self, id, - json_api_llm_provider_in_document, + json_api_org_memory_item_in_document, **kwargs ): - """PUT LLM Provider entity # noqa: E501 + """Put an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_llm_providers(id, json_api_llm_provider_in_document, async_req=True) + >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43621,7 +47918,7 @@ def update_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43652,33 +47949,30 @@ def update_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_llm_provider_in_document'] = \ - json_api_llm_provider_in_document - return self.update_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_memory_items( + def update_entity_organization_settings( self, - workspace_id, - object_id, - json_api_memory_item_in_document, + id, + json_api_organization_setting_in_document, **kwargs ): - """Put a Memory Item # noqa: E501 + """Put Organization Setting entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) + >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_memory_item_in_document (JsonApiMemoryItemInDocument): + id (str): + json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43711,7 +48005,7 @@ def update_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43740,33 +48034,29 @@ def update_entity_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_memory_item_in_document'] = \ - json_api_memory_item_in_document - return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_organization_setting_in_document'] = \ + json_api_organization_setting_in_document + return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_metrics( + def update_entity_organizations( self, - workspace_id, - object_id, - json_api_metric_in_document, + id, + json_api_organization_in_document, **kwargs ): - """Put a Metric # noqa: E501 + """Put 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.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) + >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): + id (str): + json_api_organization_in_document (JsonApiOrganizationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43803,7 +48093,7 @@ def update_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiOrganizationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43832,34 +48122,35 @@ def update_entity_metrics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_organization_in_document'] = \ + json_api_organization_in_document + return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) - def update_entity_notification_channels( + def update_entity_parameters( self, - id, - json_api_notification_channel_in_document, + workspace_id, + object_id, + json_api_parameter_in_document, **kwargs ): - """Put Notification Channel entity # noqa: E501 + """Put a Parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) + >>> thread = api.update_entity_parameters(workspace_id, object_id, json_api_parameter_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): + workspace_id (str): + object_id (str): + json_api_parameter_in_document (JsonApiParameterInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -43892,7 +48183,7 @@ def update_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + JsonApiParameterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43921,29 +48212,31 @@ def update_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_notification_channel_in_document'] = \ - json_api_notification_channel_in_document - return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_parameter_in_document'] = \ + json_api_parameter_in_document + return self.update_entity_parameters_endpoint.call_with_http_info(**kwargs) - def update_entity_organization_settings( + def update_entity_themes( self, id, - json_api_organization_setting_in_document, + json_api_theme_in_document, **kwargs ): - """Put Organization Setting entity # noqa: E501 + """Put Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) + >>> thread = api.update_entity_themes(id, json_api_theme_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): + json_api_theme_in_document (JsonApiThemeInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43979,7 +48272,7 @@ def update_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44010,27 +48303,29 @@ def update_entity_organization_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_theme_in_document'] = \ + json_api_theme_in_document + return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) - def update_entity_organizations( + def update_entity_user_data_filters( self, - id, - json_api_organization_in_document, + workspace_id, + object_id, + json_api_user_data_filter_in_document, **kwargs ): - """Put Organization # noqa: E501 + """Put a User Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) + >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): + workspace_id (str): + object_id (str): + json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44067,7 +48362,7 @@ def update_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiUserDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44096,31 +48391,32 @@ def update_entity_organizations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_user_data_filter_in_document'] = \ + json_api_user_data_filter_in_document + return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def update_entity_parameters( + def update_entity_user_groups( self, - workspace_id, - object_id, - json_api_parameter_in_document, + id, + json_api_user_group_in_document, **kwargs ): - """Put a Parameter # noqa: E501 + """Put UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_parameters(workspace_id, object_id, json_api_parameter_in_document, async_req=True) + >>> thread = api.update_entity_user_groups(id, json_api_user_group_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_parameter_in_document (JsonApiParameterInDocument): + id (str): + json_api_user_group_in_document (JsonApiUserGroupInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44157,7 +48453,7 @@ def update_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44186,31 +48482,31 @@ def update_entity_parameters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_parameter_in_document'] = \ - json_api_parameter_in_document - return self.update_entity_parameters_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_user_group_in_document'] = \ + json_api_user_group_in_document + return self.update_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def update_entity_themes( + def update_entity_user_settings( self, + user_id, id, - json_api_theme_in_document, + json_api_user_setting_in_document, **kwargs ): - """Put Theming # noqa: E501 + """Put new user settings for the user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_themes(id, json_api_theme_in_document, async_req=True) + >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): - json_api_theme_in_document (JsonApiThemeInDocument): + json_api_user_setting_in_document (JsonApiUserSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44246,7 +48542,7 @@ def update_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiUserSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44275,31 +48571,32 @@ def update_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.update_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_setting_in_document'] = \ + json_api_user_setting_in_document + return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_user_data_filters( + def update_entity_users( self, - workspace_id, - object_id, - json_api_user_data_filter_in_document, + id, + json_api_user_in_document, **kwargs ): - """Put a User Data Filter # noqa: E501 + """Put User entity # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_in_document, async_req=True) + >>> thread = api.update_entity_users(id, json_api_user_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_user_data_filter_in_document (JsonApiUserDataFilterInDocument): + id (str): + json_api_user_in_document (JsonApiUserInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44336,7 +48633,7 @@ def update_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44365,32 +48662,31 @@ def update_entity_user_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_user_data_filter_in_document'] = \ - json_api_user_data_filter_in_document - return self.update_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_user_in_document'] = \ + json_api_user_in_document + return self.update_entity_users_endpoint.call_with_http_info(**kwargs) - def update_entity_user_groups( + def update_entity_visualization_objects( self, - id, - json_api_user_group_in_document, + workspace_id, + object_id, + json_api_visualization_object_in_document, **kwargs ): - """Put UserGroup entity # noqa: E501 + """Put a Visualization Object # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_user_groups(id, json_api_user_group_in_document, async_req=True) + >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_user_group_in_document (JsonApiUserGroupInDocument): + workspace_id (str): + object_id (str): + json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44427,7 +48723,7 @@ def update_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + JsonApiVisualizationObjectOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44456,31 +48752,33 @@ def update_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.update_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_visualization_object_in_document'] = \ + json_api_visualization_object_in_document + return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def update_entity_user_settings( + def update_entity_workspace_color_palettes( self, - user_id, - id, - json_api_user_setting_in_document, + workspace_id, + object_id, + json_api_workspace_color_palette_in_document, **kwargs ): - """Put new user settings for the user # noqa: E501 + """Put a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_user_settings(user_id, id, json_api_user_setting_in_document, async_req=True) + >>> thread = api.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44516,7 +48814,7 @@ def update_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44545,32 +48843,33 @@ def update_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.update_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.update_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def update_entity_users( + def update_entity_workspace_data_filter_settings( self, - id, - json_api_user_in_document, + workspace_id, + object_id, + json_api_workspace_data_filter_setting_in_document, **kwargs ): - """Put User entity # noqa: E501 + """Put a Settings for Workspace Data Filter # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_users(id, json_api_user_in_document, async_req=True) + >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_user_in_document (JsonApiUserInDocument): + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44607,7 +48906,7 @@ def update_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44636,31 +48935,33 @@ def update_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.update_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_setting_in_document'] = \ + json_api_workspace_data_filter_setting_in_document + return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_visualization_objects( + def update_entity_workspace_data_filters( self, workspace_id, object_id, - json_api_visualization_object_in_document, + json_api_workspace_data_filter_in_document, **kwargs ): - """Put a Visualization Object # noqa: E501 + """Put a Workspace Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_in_document, async_req=True) + >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_visualization_object_in_document (JsonApiVisualizationObjectInDocument): + json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44697,7 +48998,7 @@ def update_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44730,33 +49031,32 @@ def update_entity_visualization_objects( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_visualization_object_in_document'] = \ - json_api_visualization_object_in_document - return self.update_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_data_filter_in_document'] = \ + json_api_workspace_data_filter_in_document + return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_data_filter_settings( + def update_entity_workspace_export_templates( self, workspace_id, object_id, - json_api_workspace_data_filter_setting_in_document, + json_api_workspace_export_template_in_document, **kwargs ): - """Put a Settings for Workspace Data Filter # noqa: E501 + """Put a Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> thread = api.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + json_api_workspace_export_template_in_document (JsonApiWorkspaceExportTemplateInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -44789,7 +49089,7 @@ def update_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44822,33 +49122,32 @@ def update_entity_workspace_data_filter_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.update_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_export_template_in_document'] = \ + json_api_workspace_export_template_in_document + return self.update_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_data_filters( + def update_entity_workspace_settings( self, workspace_id, object_id, - json_api_workspace_data_filter_in_document, + json_api_workspace_setting_in_document, **kwargs ): - """Put a Workspace Data Filter # noqa: E501 + """Put a Setting for a Workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 @@ -44881,7 +49180,7 @@ def update_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -44914,29 +49213,29 @@ def update_entity_workspace_data_filters( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.update_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_setting_in_document'] = \ + json_api_workspace_setting_in_document + return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_workspace_settings( + def update_entity_workspace_themes( self, workspace_id, object_id, - json_api_workspace_setting_in_document, + json_api_workspace_theme_in_document, **kwargs ): - """Put a Setting for a Workspace # noqa: E501 + """Put a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_in_document, async_req=True) + >>> thread = api.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_setting_in_document (JsonApiWorkspaceSettingInDocument): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -44972,7 +49271,7 @@ def update_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45005,9 +49304,9 @@ def update_entity_workspace_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_setting_in_document'] = \ - json_api_workspace_setting_in_document - return self.update_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.update_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) def update_entity_workspaces( self, diff --git a/gooddata-api-client/gooddata_api_client/api/export_templates_api.py b/gooddata-api-client/gooddata_api_client/api/export_templates_api.py index 030c05945..43bebcb6c 100644 --- a/gooddata-api-client/gooddata_api_client/api/export_templates_api.py +++ b/gooddata-api-client/gooddata_api_client/api/export_templates_api.py @@ -27,6 +27,11 @@ from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument from gooddata_api_client.model.json_api_export_template_post_optional_id_document import JsonApiExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument class ExportTemplatesApi(object): @@ -92,6 +97,81 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'create_entity_workspace_export_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_export_template_post_optional_id_document': + (JsonApiWorkspaceExportTemplatePostOptionalIdDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_export_template_post_optional_id_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.delete_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': None, @@ -146,6 +226,59 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'delete_entity_workspace_export_templates', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.get_all_entities_export_templates_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportTemplateOutList,), @@ -227,57 +360,101 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_export_templates_endpoint = _Endpoint( + self.get_all_entities_workspace_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), + 'response_type': (JsonApiWorkspaceExportTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'get_entity_export_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'get_all_entities_workspace_export_templates', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'origin', 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ - 'id', + 'workspace_id', ], 'nullable': [ ], 'enum': [ + 'origin', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'origin': (str,), 'filter': (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'origin': 'origin', 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', + 'workspace_id': 'path', + 'origin': 'query', 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ @@ -289,24 +466,22 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_export_templates_endpoint = _Endpoint( + self.get_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'patch_entity_export_templates', - 'http_method': 'PATCH', + 'operation_id': 'get_entity_export_templates', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_export_template_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_export_template_patch_document', ], 'nullable': [ ], @@ -330,8 +505,6 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_export_template_patch_document': - (JsonApiExportTemplatePatchDocument,), 'filter': (str,), }, @@ -341,7 +514,6 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_export_template_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -352,31 +524,111 @@ def __init__(self, api_client=None): 'application/json', 'application/vnd.gooddata.api+json' ], - 'content_type': [ + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'get_entity_workspace_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ 'application/json', 'application/vnd.gooddata.api+json' - ] + ], + 'content_type': [], }, api_client=api_client ) - self.update_entity_export_templates_endpoint = _Endpoint( + self.patch_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', - 'http_method': 'PUT', + 'operation_id': 'patch_entity_export_templates', + 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_export_template_in_document', + 'json_api_export_template_patch_document', 'filter', ], 'required': [ 'id', - 'json_api_export_template_in_document', + 'json_api_export_template_patch_document', ], 'nullable': [ ], @@ -400,8 +652,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), + 'json_api_export_template_patch_document': + (JsonApiExportTemplatePatchDocument,), 'filter': (str,), }, @@ -411,7 +663,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_export_template_in_document': 'body', + 'json_api_export_template_patch_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -429,22 +681,483 @@ def __init__(self, api_client=None): }, api_client=api_client ) - - def create_entity_export_templates( - self, - json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 + self.patch_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'patch_entity_workspace_export_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_export_template_patch_document': + (JsonApiWorkspaceExportTemplatePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_export_template_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'update_entity_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_export_template_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_export_template_in_document': + (JsonApiExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'update_entity_workspace_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_export_template_in_document': + (JsonApiWorkspaceExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document, + **kwargs + ): + """Post Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + + 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: + JsonApiExportTemplateOutDocument + 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['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + + def create_entity_workspace_export_templates( + self, + workspace_id, + json_api_workspace_export_template_post_optional_id_document, + **kwargs + ): + """Post Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_export_template_post_optional_id_document (JsonApiWorkspaceExportTemplatePostOptionalIdDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['json_api_workspace_export_template_post_optional_id_document'] = \ + json_api_workspace_export_template_post_optional_id_document + return self.create_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_export_templates( + self, + id, + **kwargs + ): + """Delete Export Template entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_export_templates(id, async_req=True) + >>> result = thread.get() + + Args: + 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: + 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['id'] = \ + id + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_export_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_workspace_export_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -479,7 +1192,7 @@ def create_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -508,27 +1221,31 @@ def create_entity_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_templates( + def get_all_entities_export_templates( self, - id, **kwargs ): - """Delete Export Template entity # noqa: E501 + """GET all Export Template entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_export_templates(id, async_req=True) + >>> thread = api.get_all_entities_export_templates(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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 @@ -561,7 +1278,7 @@ def delete_entity_export_templates( async_req (bool): execute request asynchronously Returns: - None + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -590,28 +1307,31 @@ def delete_entity_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( + def get_all_entities_workspace_export_templates( self, + workspace_id, **kwargs ): - """GET all Export Template entities # noqa: E501 + """Get all Workspace Export Templates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_templates(async_req=True) + >>> thread = api.get_all_entities_workspace_export_templates(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -645,7 +1365,7 @@ def get_all_entities_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutList + JsonApiWorkspaceExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -674,7 +1394,9 @@ def get_all_entities_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_export_templates_endpoint.call_with_http_info(**kwargs) def get_entity_export_templates( self, @@ -759,6 +1481,95 @@ def get_entity_export_templates( id return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def get_entity_workspace_export_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_export_templates(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + def patch_entity_export_templates( self, id, @@ -846,6 +1657,97 @@ def patch_entity_export_templates( json_api_export_template_patch_document return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def patch_entity_workspace_export_templates( + self, + workspace_id, + object_id, + json_api_workspace_export_template_patch_document, + **kwargs + ): + """Patch a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_export_template_patch_document (JsonApiWorkspaceExportTemplatePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_patch_document'] = \ + json_api_workspace_export_template_patch_document + return self.patch_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + def update_entity_export_templates( self, id, @@ -933,3 +1835,94 @@ def update_entity_export_templates( json_api_export_template_in_document return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + def update_entity_workspace_export_templates( + self, + workspace_id, + object_id, + json_api_workspace_export_template_in_document, + **kwargs + ): + """Put a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_export_template_in_document (JsonApiWorkspaceExportTemplateInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_in_document'] = \ + json_api_workspace_export_template_in_document + return self.update_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/fiscal_calendar_controller_api.py b/gooddata-api-client/gooddata_api_client/api/fiscal_calendar_controller_api.py new file mode 100644 index 000000000..ec621de85 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/fiscal_calendar_controller_api.py @@ -0,0 +1,388 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList + + +class FiscalCalendarControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.get_all_entities_fiscal_calendars_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFiscalCalendarOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars', + 'operation_id': 'get_all_entities_fiscal_calendars', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_fiscal_calendars_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFiscalCalendarOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}', + 'operation_id': 'get_entity_fiscal_calendars', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def get_all_entities_fiscal_calendars( + self, + workspace_id, + **kwargs + ): + """Get all Fiscal Calendars # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_fiscal_calendars(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiFiscalCalendarOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_fiscal_calendars_endpoint.call_with_http_info(**kwargs) + + def get_entity_fiscal_calendars( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Fiscal Calendar # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_fiscal_calendars(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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: + JsonApiFiscalCalendarOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_fiscal_calendars_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py b/gooddata-api-client/gooddata_api_client/api/fiscal_calendars_api.py similarity index 58% rename from gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py rename to gooddata-api-client/gooddata_api_client/api/fiscal_calendars_api.py index 4020a745c..a71b95102 100644 --- a/gooddata-api-client/gooddata_api_client/api/metadata_sync_api.py +++ b/gooddata-api-client/gooddata_api_client/api/fiscal_calendars_api.py @@ -22,9 +22,11 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList -class MetadataSyncApi(object): +class FiscalCalendarsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -35,18 +37,25 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.metadata_sync_endpoint = _Endpoint( + self.get_all_entities_fiscal_calendars_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiFiscalCalendarOutList,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metadataSync', - 'operation_id': 'metadata_sync', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars', + 'operation_id': 'get_all_entities_fiscal_calendars', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ 'workspace_id', @@ -54,47 +63,105 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'origin', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { 'workspace_id': (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', }, 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], 'content_type': [], }, api_client=api_client ) - self.metadata_sync_organization_endpoint = _Endpoint( + self.get_entity_fiscal_calendars_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (JsonApiFiscalCalendarOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/actions/organization/metadataSync', - 'operation_id': 'metadata_sync_organization', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}', + 'operation_id': 'get_entity_fiscal_calendars', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'object_id', ], - 'required': [], 'nullable': [ ], 'enum': [ @@ -108,39 +175,64 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), }, 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', }, 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], 'content_type': [], }, api_client=api_client ) - def metadata_sync( + def get_all_entities_fiscal_calendars( self, workspace_id, **kwargs ): - """(BETA) Sync Metadata to other services # noqa: E501 + """Get all Fiscal Calendars # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync(workspace_id, async_req=True) + >>> thread = api.get_all_entities_fiscal_calendars(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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 @@ -173,7 +265,7 @@ def metadata_sync( async_req (bool): execute request asynchronously Returns: - None + JsonApiFiscalCalendarOutList If the method is called asynchronously, returns the request thread. """ @@ -204,23 +296,29 @@ def metadata_sync( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.metadata_sync_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_fiscal_calendars_endpoint.call_with_http_info(**kwargs) - def metadata_sync_organization( + def get_entity_fiscal_calendars( self, + workspace_id, + object_id, **kwargs ): - """(BETA) Sync organization scope Metadata to other services # noqa: E501 + """Get a Fiscal Calendar # noqa: E501 - (BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.metadata_sync_organization(async_req=True) + >>> thread = api.get_entity_fiscal_calendars(workspace_id, object_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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 @@ -253,7 +351,7 @@ def metadata_sync_organization( async_req (bool): execute request asynchronously Returns: - None + JsonApiFiscalCalendarOutDocument If the method is called asynchronously, returns the request thread. """ @@ -282,5 +380,9 @@ def metadata_sync_organization( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.metadata_sync_organization_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_fiscal_calendars_endpoint.call_with_http_info(**kwargs) diff --git a/gooddata-api-client/gooddata_api_client/api/org_memory_item_controller_api.py b/gooddata-api-client/gooddata_api_client/api/org_memory_item_controller_api.py new file mode 100644 index 000000000..679c08d15 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/org_memory_item_controller_api.py @@ -0,0 +1,1010 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument + + +class OrgMemoryItemControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'create_entity_org_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_org_memory_item_in_document', + 'include', + ], + 'required': [ + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_org_memory_item_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'delete_entity_org_memory_items', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'get_all_entities_org_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'get_entity_org_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'patch_entity_org_memory_items', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_patch_document': + (JsonApiOrgMemoryItemPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'update_entity_org_memory_items', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_org_memory_items( + self, + json_api_org_memory_item_in_document, + **kwargs + ): + """Post organization Memory Item entities # noqa: E501 + + Organization-scoped AI memory item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def delete_entity_org_memory_items( + self, + id, + **kwargs + ): + """Delete an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + 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: + 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['id'] = \ + id + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_org_memory_items( + self, + **kwargs + ): + """Get all organization Memory Item entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_org_memory_items(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [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: + JsonApiOrgMemoryItemOutList + 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.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_entity_org_memory_items( + self, + id, + **kwargs + ): + """Get an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def patch_entity_org_memory_items( + self, + id, + json_api_org_memory_item_patch_document, + **kwargs + ): + """Patch an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + kwargs['json_api_org_memory_item_patch_document'] = \ + json_api_org_memory_item_patch_document + return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def update_entity_org_memory_items( + self, + id, + json_api_org_memory_item_in_document, + **kwargs + ): + """Put an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [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: + JsonApiOrgMemoryItemOutDocument + 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['id'] = \ + id + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + 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 f42111d36..47730a5a1 100644 --- a/gooddata-api-client/gooddata_api_client/api/permissions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/permissions_api.py @@ -32,6 +32,8 @@ from gooddata_api_client.model.ldm_object_permissions import LdmObjectPermissions from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +from gooddata_api_client.model.metric_permissions import MetricPermissions from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment @@ -805,6 +807,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.manage_metric_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions', + 'operation_id': 'manage_metric_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'metric_id', + 'manage_metric_permissions_request_inner', + ], + 'required': [ + 'workspace_id', + 'metric_id', + 'manage_metric_permissions_request_inner', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'metric_id': + (str,), + 'manage_metric_permissions_request_inner': + ([ManageMetricPermissionsRequestInner],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'metric_id': 'metricId', + }, + 'location_map': { + 'workspace_id': 'path', + 'metric_id': 'path', + 'manage_metric_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.manage_organization_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -907,6 +969,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.metric_permissions_endpoint = _Endpoint( + settings={ + 'response_type': (MetricPermissions,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions', + 'operation_id': 'metric_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'metric_id', + ], + 'required': [ + 'workspace_id', + 'metric_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'metric_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'metric_id': 'metricId', + }, + 'location_map': { + 'workspace_id': 'path', + 'metric_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.set_organization_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2322,6 +2439,96 @@ def manage_label_permissions( manage_attribute_permissions_request_inner return self.manage_label_permissions_endpoint.call_with_http_info(**kwargs) + def manage_metric_permissions( + self, + workspace_id, + metric_id, + manage_metric_permissions_request_inner, + **kwargs + ): + """(BETA) 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 + + >>> thread = api.manage_metric_permissions(workspace_id, metric_id, manage_metric_permissions_request_inner, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + metric_id (str): + manage_metric_permissions_request_inner ([ManageMetricPermissionsRequestInner]): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['metric_id'] = \ + metric_id + kwargs['manage_metric_permissions_request_inner'] = \ + manage_metric_permissions_request_inner + return self.manage_metric_permissions_endpoint.call_with_http_info(**kwargs) + def manage_organization_permissions( self, organization_permission_assignment, @@ -2492,6 +2699,92 @@ def manage_workspace_permissions( workspace_permission_assignment return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) + def metric_permissions( + self, + workspace_id, + metric_id, + **kwargs + ): + """(BETA) 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 + + >>> thread = api.metric_permissions(workspace_id, metric_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + metric_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: + MetricPermissions + 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['metric_id'] = \ + metric_id + return self.metric_permissions_endpoint.call_with_http_info(**kwargs) + def set_organization_permissions( self, declarative_organization_permission, diff --git a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py index 30f01179f..9faa9626e 100644 --- a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py @@ -687,17 +687,10 @@ def __init__(self, api_client=None): 'enum': [ ], 'validation': [ - 'workspace_id', ] }, root_map={ 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, @@ -1398,17 +1391,10 @@ def __init__(self, api_client=None): 'enum': [ ], 'validation': [ - 'workspace_id', ] }, root_map={ 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, @@ -2546,7 +2532,7 @@ def created_by( >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + workspace_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -2621,9 +2607,9 @@ def forecast( forecast_request, **kwargs ): - """(BETA) Smart functions - Forecast # noqa: E501 + """Smart functions - Forecast # noqa: E501 - (BETA) Computes forecasted data points from the provided execution result and parameters. # noqa: E501 + Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2712,9 +2698,9 @@ def forecast_result( result_id, **kwargs ): - """(BETA) Smart functions - Forecast Result # noqa: E501 + """Smart functions - Forecast Result # noqa: E501 - (BETA) Gets forecast result. # noqa: E501 + Gets forecast result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3569,7 +3555,7 @@ def tags( >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + workspace_id (str): Keyword Args: _return_http_data_only (bool): response data without head status diff --git a/gooddata-api-client/gooddata_api_client/api/user_management_api.py b/gooddata-api-client/gooddata_api_client/api/user_management_api.py index 3a0b2e362..2778dc66c 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_management_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_management_api.py @@ -206,6 +206,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'user_id', + 'include_inherited', ], 'required': [ 'user_id', @@ -225,12 +226,16 @@ def __init__(self, api_client=None): 'openapi_types': { 'user_id': (str,), + 'include_inherited': + (bool,), }, 'attribute_map': { 'user_id': 'userId', + 'include_inherited': 'includeInherited', }, 'location_map': { 'user_id': 'path', + 'include_inherited': 'query', }, 'collection_format_map': { } @@ -255,6 +260,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'user_group_id', + 'include_inherited', ], 'required': [ 'user_group_id', @@ -274,12 +280,16 @@ def __init__(self, api_client=None): 'openapi_types': { 'user_group_id': (str,), + 'include_inherited': + (bool,), }, 'attribute_map': { 'user_group_id': 'userGroupId', + 'include_inherited': 'includeInherited', }, 'location_map': { 'user_group_id': 'path', + 'include_inherited': 'query', }, 'collection_format_map': { } @@ -1085,6 +1095,7 @@ def list_permissions_for_user( user_id (str): Keyword Args: + include_inherited (bool): When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).. [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 @@ -1167,6 +1178,7 @@ def list_permissions_for_user_group( user_group_id (str): Keyword Args: + include_inherited (bool): When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).. [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 @@ -1501,7 +1513,7 @@ def list_workspace_users( Keyword Args: 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 - name (str): Filter by user name. Note that user name is case insensitive.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [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 diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_color_palette_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_color_palette_controller_api.py new file mode 100644 index 000000000..cbb789d85 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_color_palette_controller_api.py @@ -0,0 +1,1030 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument + + +class WorkspaceColorPaletteControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'create_entity_workspace_color_palettes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'delete_entity_workspace_color_palettes', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'get_all_entities_workspace_color_palettes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'get_entity_workspace_color_palettes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'patch_entity_workspace_color_palettes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_patch_document': + (JsonApiWorkspaceColorPalettePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'update_entity_workspace_color_palettes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_color_palette_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_color_palette_in_document': + (JsonApiWorkspaceColorPaletteInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_color_palette_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_color_palettes( + self, + workspace_id, + json_api_workspace_color_palette_in_document, + **kwargs + ): + """Post Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.create_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_color_palettes( + self, + workspace_id, + **kwargs + ): + """Get all Workspace Color Palettes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_color_palettes(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceColorPaletteOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + json_api_workspace_color_palette_patch_document, + **kwargs + ): + """Patch a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_patch_document (JsonApiWorkspaceColorPalettePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_patch_document'] = \ + json_api_workspace_color_palette_patch_document + return self.patch_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_color_palettes( + self, + workspace_id, + object_id, + json_api_workspace_color_palette_in_document, + **kwargs + ): + """Put a Workspace Color Palette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceColorPaletteOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.update_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_export_template_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_export_template_controller_api.py new file mode 100644 index 000000000..bd7610cfd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_export_template_controller_api.py @@ -0,0 +1,1031 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument + + +class WorkspaceExportTemplateControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'create_entity_workspace_export_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_export_template_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_export_template_post_optional_id_document': + (JsonApiWorkspaceExportTemplatePostOptionalIdDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_export_template_post_optional_id_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'delete_entity_workspace_export_templates', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates', + 'operation_id': 'get_all_entities_workspace_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'get_entity_workspace_export_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'patch_entity_workspace_export_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_export_template_patch_document': + (JsonApiWorkspaceExportTemplatePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_export_template_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceExportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'update_entity_workspace_export_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_export_template_in_document': + (JsonApiWorkspaceExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_export_templates( + self, + workspace_id, + json_api_workspace_export_template_post_optional_id_document, + **kwargs + ): + """Post Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_export_template_post_optional_id_document (JsonApiWorkspaceExportTemplatePostOptionalIdDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['json_api_workspace_export_template_post_optional_id_document'] = \ + json_api_workspace_export_template_post_optional_id_document + return self.create_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_export_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_export_templates(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_export_templates( + self, + workspace_id, + **kwargs + ): + """Get all Workspace Export Templates # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_export_templates(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceExportTemplateOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_export_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_export_templates(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_export_templates( + self, + workspace_id, + object_id, + json_api_workspace_export_template_patch_document, + **kwargs + ): + """Patch a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_export_template_patch_document (JsonApiWorkspaceExportTemplatePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_patch_document'] = \ + json_api_workspace_export_template_patch_document + return self.patch_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_export_templates( + self, + workspace_id, + object_id, + json_api_workspace_export_template_in_document, + **kwargs + ): + """Put a Workspace Export Template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_export_template_in_document (JsonApiWorkspaceExportTemplateInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceExportTemplateOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_in_document'] = \ + json_api_workspace_export_template_in_document + return self.update_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/workspace_theme_controller_api.py b/gooddata-api-client/gooddata_api_client/api/workspace_theme_controller_api.py new file mode 100644 index 000000000..da636c267 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/workspace_theme_controller_api.py @@ -0,0 +1,1030 @@ +""" + 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.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument + + +class WorkspaceThemeControllerApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'create_entity_workspace_themes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'delete_entity_workspace_themes', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes', + 'operation_id': 'get_all_entities_workspace_themes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'get_entity_workspace_themes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'patch_entity_workspace_themes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_patch_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_theme_patch_document': + (JsonApiWorkspaceThemePatchDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_theme_patch_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_workspace_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}', + 'operation_id': 'update_entity_workspace_themes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + 'filter', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_workspace_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_workspace_theme_in_document': + (JsonApiWorkspaceThemeInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_workspace_theme_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_workspace_themes( + self, + workspace_id, + json_api_workspace_theme_in_document, + **kwargs + ): + """Post Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceThemeOutDocument + 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['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.create_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_workspace_themes( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_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: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_workspace_themes( + self, + workspace_id, + **kwargs + ): + """Get all Workspace Themes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_workspace_themes(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceThemeOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def get_entity_workspace_themes( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_workspace_themes(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [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: + JsonApiWorkspaceThemeOutDocument + 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['object_id'] = \ + object_id + return self.get_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_workspace_themes( + self, + workspace_id, + object_id, + json_api_workspace_theme_patch_document, + **kwargs + ): + """Patch a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_theme_patch_document (JsonApiWorkspaceThemePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceThemeOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_theme_patch_document'] = \ + json_api_workspace_theme_patch_document + return self.patch_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + + def update_entity_workspace_themes( + self, + workspace_id, + object_id, + json_api_workspace_theme_in_document, + **kwargs + ): + """Put a Workspace Theme # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [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: + JsonApiWorkspaceThemeOutDocument + 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['object_id'] = \ + object_id + kwargs['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.update_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index 92abedf37..39ee6bd20 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -20,6 +20,7 @@ from gooddata_api_client.api.ai_lake_databases_api import AILakeDatabasesApi from gooddata_api_client.api.ai_lake_pipe_tables_api import AILakePipeTablesApi from gooddata_api_client.api.ai_lake_services_operations_api import AILakeServicesOperationsApi +from gooddata_api_client.api.ai_observability_api import AIObservabilityApi from gooddata_api_client.api.api_tokens_api import APITokensApi from gooddata_api_client.api.analytics_model_api import AnalyticsModelApi from gooddata_api_client.api.appearance_api import AppearanceApi @@ -51,6 +52,7 @@ from gooddata_api_client.api.facts_api import FactsApi from gooddata_api_client.api.filter_context_api import FilterContextApi from gooddata_api_client.api.filter_views_api import FilterViewsApi +from gooddata_api_client.api.fiscal_calendars_api import FiscalCalendarsApi from gooddata_api_client.api.generate_logical_data_model_api import GenerateLogicalDataModelApi from gooddata_api_client.api.geographic_data_api import GeographicDataApi from gooddata_api_client.api.hierarchy_api import HierarchyApi @@ -63,7 +65,6 @@ from gooddata_api_client.api.llm_providers_api import LLMProvidersApi from gooddata_api_client.api.labels_api import LabelsApi from gooddata_api_client.api.manage_permissions_api import ManagePermissionsApi -from gooddata_api_client.api.metadata_sync_api import MetadataSyncApi from gooddata_api_client.api.metrics_api import MetricsApi from gooddata_api_client.api.notification_channels_api import NotificationChannelsApi from gooddata_api_client.api.ogcapi_features_api import OGCAPIFeaturesApi @@ -124,6 +125,7 @@ from gooddata_api_client.api.fact_controller_api import FactControllerApi from gooddata_api_client.api.filter_context_controller_api import FilterContextControllerApi from gooddata_api_client.api.filter_view_controller_api import FilterViewControllerApi +from gooddata_api_client.api.fiscal_calendar_controller_api import FiscalCalendarControllerApi from gooddata_api_client.api.identity_provider_controller_api import IdentityProviderControllerApi from gooddata_api_client.api.ip_allowlist_policy_controller_api import IpAllowlistPolicyControllerApi from gooddata_api_client.api.jwk_controller_api import JwkControllerApi @@ -135,6 +137,7 @@ from gooddata_api_client.api.metric_controller_api import MetricControllerApi from gooddata_api_client.api.notification_channel_controller_api import NotificationChannelControllerApi from gooddata_api_client.api.notification_channel_identifier_controller_api import NotificationChannelIdentifierControllerApi +from gooddata_api_client.api.org_memory_item_controller_api import OrgMemoryItemControllerApi from gooddata_api_client.api.organization_entity_controller_api import OrganizationEntityControllerApi from gooddata_api_client.api.organization_setting_controller_api import OrganizationSettingControllerApi from gooddata_api_client.api.parameter_controller_api import ParameterControllerApi @@ -145,7 +148,10 @@ from gooddata_api_client.api.user_identifier_controller_api import UserIdentifierControllerApi from gooddata_api_client.api.user_setting_controller_api import UserSettingControllerApi from gooddata_api_client.api.visualization_object_controller_api import VisualizationObjectControllerApi +from gooddata_api_client.api.workspace_color_palette_controller_api import WorkspaceColorPaletteControllerApi from gooddata_api_client.api.workspace_controller_api import WorkspaceControllerApi from gooddata_api_client.api.workspace_data_filter_controller_api import WorkspaceDataFilterControllerApi from gooddata_api_client.api.workspace_data_filter_setting_controller_api import WorkspaceDataFilterSettingControllerApi +from gooddata_api_client.api.workspace_export_template_controller_api import WorkspaceExportTemplateControllerApi from gooddata_api_client.api.workspace_setting_controller_api import WorkspaceSettingControllerApi +from gooddata_api_client.api.workspace_theme_controller_api import WorkspaceThemeControllerApi diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py index 44320c1d5..ffe0f35cb 100644 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py @@ -70,12 +70,12 @@ class AbsoluteDateFilterAbsoluteDateFilter(ModelNormal): validations = { ('_from',): { 'regex': { - 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$', # noqa: E501 + 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2}(:\d{1,2})?)?$', # noqa: E501 }, }, ('to',): { 'regex': { - 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2})?$', # noqa: E501 + 'pattern': r'^\d{4}-\d{1,2}-\d{1,2}( \d{1,2}:\d{1,2}(:\d{1,2})?)?$', # noqa: E501 }, }, } diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter.py new file mode 100644 index 000000000..efe8d3456 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_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.absolute_granularity_date_filter_absolute_granularity_date_filter import AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter + globals()['AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter + + +class AbsoluteGranularityDateFilter(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 { + 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, absolute_granularity_date_filter, *args, **kwargs): # noqa: E501 + """AbsoluteGranularityDateFilter - a model defined in OpenAPI + + Args: + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): + + 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.absolute_granularity_date_filter = absolute_granularity_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, absolute_granularity_date_filter, *args, **kwargs): # noqa: E501 + """AbsoluteGranularityDateFilter - a model defined in OpenAPI + + Args: + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): + + 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.absolute_granularity_date_filter = absolute_granularity_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/list_llm_provider_models_request_provider_config.py b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py similarity index 60% rename from gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request_provider_config.py rename to gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py index 35317fab0..bb8ace11b 100644 --- a/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request_provider_config.py +++ b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py @@ -31,19 +31,11 @@ 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.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()['OpenAIProviderConfig'] = OpenAIProviderConfig - globals()['OpenAiProviderAuth'] = OpenAiProviderAuth - - -class ListLlmProviderModelsRequestProviderConfig(ModelComposed): + from gooddata_api_client.model.afm_object_identifier_dataset import AfmObjectIdentifierDataset + globals()['AfmObjectIdentifierDataset'] = AfmObjectIdentifierDataset + + +class AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -68,23 +60,65 @@ class ListLlmProviderModelsRequestProviderConfig(ModelComposed): """ allowed_values = { - ('type',): { - 'OPENAI': "OPENAI", + ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", + 'MINUTE': "MINUTE", + 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", + 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", + 'DAY_OF_WEEK': "DAY_OF_WEEK", + 'DAY_OF_MONTH': "DAY_OF_MONTH", + 'DAY_OF_QUARTER': "DAY_OF_QUARTER", + 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", + 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", + 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", + 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", + 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", + 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", + 'FISCAL_YEAR': "FISCAL_YEAR", + }, + ('empty_value_handling',): { + 'INCLUDE': "INCLUDE", + 'EXCLUDE': "EXCLUDE", + 'ONLY': "ONLY", }, } validations = { - ('base_url',): { - 'max_length': 255, - }, - ('organization',): { - 'max_length': 255, - }, - ('region',): { - 'max_length': 255, + ('_from',): { + 'regex': { + 'pattern': r'^((?:\d{4})|(?:\d{4}-[1-4])|(?:\d{4}-(0[1-9]|1[0-2]))|(?:\d{4}-(0[1-9]|[1-4]\d|5[0-3]))|(?:\d{4}-\d{2}-\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,3}|[1-7]\d{4}|8[0-5]\d{3}|86[0-3]\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,2}|1[0-3]\d{2}|14[0-3]\d)|(?:[0-9]|1\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\d|3[01])|(?:[1-9]|[1-8]\d|9[0-2])|(?:[1-9]|[1-9]\d|[12]\d\d|3[0-5]\d|36[0-6])|(?:[1-9]|[1-4]\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$', # noqa: E501 + }, }, - ('endpoint',): { - 'max_length': 255, + ('to',): { + 'regex': { + 'pattern': r'^((?:\d{4})|(?:\d{4}-[1-4])|(?:\d{4}-(0[1-9]|1[0-2]))|(?:\d{4}-(0[1-9]|[1-4]\d|5[0-3]))|(?:\d{4}-\d{2}-\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,3}|[1-7]\d{4}|8[0-5]\d{3}|86[0-3]\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,2}|1[0-3]\d{2}|14[0-3]\d)|(?:[0-9]|1\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\d|3[01])|(?:[1-9]|[1-8]\d|9[0-2])|(?:[1-9]|[1-9]\d|[12]\d\d|3[0-5]\d|36[0-6])|(?:[1-9]|[1-4]\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$', # noqa: E501 + }, }, } @@ -111,12 +145,13 @@ def openapi_types(): """ lazy_import() return { - 'base_url': (str,), # noqa: E501 - 'organization': (str, none_type,), # noqa: E501 - 'auth': (OpenAiProviderAuth,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'region': (str,), # noqa: E501 - 'endpoint': (str,), # noqa: E501 + 'dataset': (AfmObjectIdentifierDataset,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'apply_on_result': (bool,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 + '_from': (str, none_type,), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + 'to': (str, none_type,), # noqa: E501 } @cached_property @@ -125,21 +160,28 @@ def discriminator(): attribute_map = { - 'base_url': 'baseUrl', # noqa: E501 - 'organization': 'organization', # noqa: E501 - 'auth': 'auth', # noqa: E501 - 'type': 'type', # noqa: E501 - 'region': 'region', # noqa: E501 - 'endpoint': 'endpoint', # noqa: E501 + 'dataset': 'dataset', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'apply_on_result': 'applyOnResult', # noqa: E501 + 'empty_value_handling': 'emptyValueHandling', # noqa: E501 + '_from': 'from', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 + 'to': 'to', # noqa: E501 } read_only_vars = { } + _composed_schemas = {} + @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ListLlmProviderModelsRequestProviderConfig - a model defined in OpenAPI + def _from_openapi_data(cls, dataset, granularity, *args, **kwargs): # noqa: E501 + """AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter - a model defined in OpenAPI + + Args: + dataset (AfmObjectIdentifierDataset): + granularity (str): Granularity determining the filtered date attribute and the expected 'from'/'to' format. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -172,16 +214,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 - organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 - auth (OpenAiProviderAuth): [optional] # noqa: E501 - type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - region (str): AWS region for Bedrock.. [optional] # noqa: E501 - endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 + 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 + _from (str, none_type): Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.. [optional] # noqa: E501 + local_identifier (str): [optional] # noqa: E501 + to (str, none_type): End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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', ()) @@ -209,29 +250,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - + self.dataset = dataset + self.granularity = granularity for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ + if var_name not in self.attribute_map and \ self._configuration is not None and \ self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: + self.additional_properties_type is None: # discard variable. continue setattr(self, var_name, var_value) - return self required_properties = set([ @@ -241,14 +269,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 '_path_to_item', '_configuration', '_visited_composed_classes', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ListLlmProviderModelsRequestProviderConfig - a model defined in OpenAPI + def __init__(self, dataset, granularity, *args, **kwargs): # noqa: E501 + """AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter - a model defined in OpenAPI + + Args: + dataset (AfmObjectIdentifierDataset): + granularity (str): Granularity determining the filtered date attribute and the expected 'from'/'to' format. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -281,12 +310,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - base_url (str): Custom base URL for OpenAI API.. [optional] if omitted the server will use the default value of "https://api.openai.com/v1" # noqa: E501 - organization (str, none_type): OpenAI organization ID.. [optional] # noqa: E501 - auth (OpenAiProviderAuth): [optional] # noqa: E501 - type (str): Provider type.. [optional] if omitted the server will use the default value of "OPENAI" # noqa: E501 - region (str): AWS region for Bedrock.. [optional] # noqa: E501 - endpoint (str): Azure OpenAI endpoint URL.. [optional] # noqa: E501 + 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 + _from (str, none_type): Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.. [optional] # noqa: E501 + local_identifier (str): [optional] # noqa: E501 + to (str, none_type): End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -316,51 +344,16 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - + self.dataset = dataset + self.granularity = granularity for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ + if var_name not in self.attribute_map and \ self._configuration is not None and \ self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: + 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AnthropicProviderConfig, - AwsBedrockProviderConfig, - AzureFoundryProviderConfig, - OpenAIProviderConfig, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/afm.py b/gooddata-api-client/gooddata_api_client/model/afm.py index 4f4aed026..59915a33a 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm.py +++ b/gooddata-api-client/gooddata_api_client/model/afm.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.afm_filters_inner import AFMFiltersInner from gooddata_api_client.model.attribute_item import AttributeItem + from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.measure_item import MeasureItem from gooddata_api_client.model.metric_definition_override import MetricDefinitionOverride from gooddata_api_client.model.parameter_item import ParameterItem - globals()['AFMFiltersInner'] = AFMFiltersInner globals()['AttributeItem'] = AttributeItem + globals()['FilterDefinition'] = FilterDefinition globals()['MeasureItem'] = MeasureItem globals()['MetricDefinitionOverride'] = MetricDefinitionOverride globals()['ParameterItem'] = ParameterItem @@ -97,7 +97,7 @@ def openapi_types(): lazy_import() return { 'attributes': ([AttributeItem],), # noqa: E501 - 'filters': ([AFMFiltersInner],), # noqa: E501 + 'filters': ([FilterDefinition],), # noqa: E501 'measures': ([MeasureItem],), # noqa: E501 'aux_measures': ([MeasureItem],), # noqa: E501 'measure_definition_overrides': ([MetricDefinitionOverride],), # noqa: E501 @@ -130,7 +130,7 @@ def _from_openapi_data(cls, attributes, filters, measures, *args, **kwargs): # Args: attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([AFMFiltersInner]): Various filter types to filter the execution result. + filters ([FilterDefinition]): Various filter types to filter the execution result. measures ([MeasureItem]): Metrics to be computed. Keyword Args: @@ -226,7 +226,7 @@ def __init__(self, attributes, filters, measures, *args, **kwargs): # noqa: E50 Args: attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([AFMFiltersInner]): Various filter types to filter the execution result. + filters ([FilterDefinition]): Various filter types to filter the execution result. measures ([MeasureItem]): Metrics to be computed. Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py deleted file mode 100644 index f607f4068..000000000 --- a/gooddata-api-client/gooddata_api_client/model/afm_filters_inner.py +++ /dev/null @@ -1,381 +0,0 @@ -""" - 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.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter - from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter - from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure - from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition - from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline - 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.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['AbstractMeasureValueFilter'] = AbstractMeasureValueFilter - globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['CompoundMeasureValueFilterCompoundMeasureValueFilter'] = CompoundMeasureValueFilterCompoundMeasureValueFilter - globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure - globals()['InlineFilterDefinition'] = InlineFilterDefinition - globals()['InlineFilterDefinitionInline'] = InlineFilterDefinitionInline - globals()['MatchAttributeFilterMatchAttributeFilter'] = MatchAttributeFilterMatchAttributeFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class AFMFiltersInner(ModelComposed): - """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 = { - } - - additional_properties_type = None - - _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 { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 - 'inline': (InlineFilterDefinitionInline,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 - 'inline': 'inline', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AFMFiltersInner - 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,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [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 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [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', ()) - - 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """AFMFiltersInner - 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,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [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 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AbstractMeasureValueFilter, - FilterDefinitionForSimpleMeasure, - InlineFilterDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py b/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py index 9f4952813..7c903e928 100644 --- a/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py @@ -56,6 +56,9 @@ class AggregateKeyConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'AGGREGATE': "aggregate", + }, } validations = { @@ -82,6 +85,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'columns': ([str],), # noqa: E501 } @@ -91,6 +95,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'columns': 'columns', # noqa: E501 } @@ -104,7 +109,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """AggregateKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "aggregate", must be one of ["aggregate", ] # 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. @@ -138,6 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "aggregate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -167,6 +176,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -190,7 +200,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """AggregateKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "aggregate", must be one of ["aggregate", ] # 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. @@ -224,6 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "aggregate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -251,6 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py index 9b45c7a9c..d4242b208 100644 --- a/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py @@ -66,24 +66,45 @@ class AllTimeDateFilterAllTimeDateFilter(ModelNormal): 'ONLY': "ONLY", }, ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.py b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.py index c827444d6..32403e18a 100644 --- a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.py +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_created_by.py @@ -113,8 +113,8 @@ def _from_openapi_data(cls, reasoning, users, *args, **kwargs): # noqa: E501 """AnalyticsCatalogCreatedBy - a model defined in OpenAPI Args: - reasoning (str): Reasoning for error states - users ([AnalyticsCatalogUser]): Users who created any object in the catalog + reasoning (str): Reserved for future use. Always empty string in the current implementation. + users ([AnalyticsCatalogUser]): Distinct users who have created at least one catalog object. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -204,8 +204,8 @@ def __init__(self, reasoning, users, *args, **kwargs): # noqa: E501 """AnalyticsCatalogCreatedBy - a model defined in OpenAPI Args: - reasoning (str): Reasoning for error states - users ([AnalyticsCatalogUser]): Users who created any object in the catalog + reasoning (str): Reserved for future use. Always empty string in the current implementation. + users ([AnalyticsCatalogUser]): Distinct users who have created at least one catalog object. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py index 7f7a25235..6b373f54a 100644 --- a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_tags.py @@ -105,7 +105,7 @@ def _from_openapi_data(cls, tags, *args, **kwargs): # noqa: E501 """AnalyticsCatalogTags - a model defined in OpenAPI Args: - tags ([str]): + tags ([str]): Sorted, distinct tag strings found in the workspace hierarchy. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -194,7 +194,7 @@ def __init__(self, tags, *args, **kwargs): # noqa: E501 """AnalyticsCatalogTags - a model defined in OpenAPI Args: - tags ([str]): + tags ([str]): Sorted, distinct tag strings found in the workspace hierarchy. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.py b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.py index 50fe1b7fe..9878c842b 100644 --- a/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.py +++ b/gooddata-api-client/gooddata_api_client/model/analytics_catalog_user.py @@ -109,9 +109,9 @@ def _from_openapi_data(cls, firstname, lastname, user_id, *args, **kwargs): # n """AnalyticsCatalogUser - a model defined in OpenAPI Args: - firstname (str): First name of the user who created any objects - lastname (str): Last name of the user who created any objects - user_id (str): User ID of the user who created any objects + firstname (str): User first name. + lastname (str): User last name. + user_id (str): User identifier. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -202,9 +202,9 @@ def __init__(self, firstname, lastname, user_id, *args, **kwargs): # noqa: E501 """AnalyticsCatalogUser - a model defined in OpenAPI Args: - firstname (str): First name of the user who created any objects - lastname (str): Last name of the user who created any objects - user_id (str): User ID of the user who created any objects + firstname (str): User first name. + lastname (str): User last name. + user_id (str): User identifier. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py index fe21ac29c..ed9c61511 100644 --- a/gooddata-api-client/gooddata_api_client/model/api_entitlement.py +++ b/gooddata-api-client/gooddata_api_client/model/api_entitlement.py @@ -90,6 +90,7 @@ class ApiEntitlement(ModelNormal): 'AIKNOWLEDGESTORAGELIMIT': "AiKnowledgeStorageLimit", 'AIAGENTLIMIT': "AiAgentLimit", 'AIWORKSPACELIMIT': "AiWorkspaceLimit", + 'AIOBSERVABILITY': "AiObservability", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py b/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py index 082dc36fe..3cb918b59 100644 --- a/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/assignee_identifier.py @@ -63,6 +63,11 @@ class AssigneeIdentifier(ModelNormal): } validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, } @cached_property @@ -111,7 +116,7 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 """AssigneeIdentifier - a model defined in OpenAPI Args: - id (str): + id (str): Identifier of the assignee. type (str): Keyword Args: @@ -202,7 +207,7 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 """AssigneeIdentifier - a model defined in OpenAPI Args: - id (str): + id (str): Identifier of the assignee. type (str): Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py index 2b67440aa..9968ba180 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py +++ b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py @@ -65,24 +65,45 @@ class AttributeHeaderAttributeHeader(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, ('value_type',): { diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert.py b/gooddata-api-client/gooddata_api_client/model/automation_alert.py index 23b982a90..aac63158f 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert.py +++ b/gooddata-api-client/gooddata_api_client/model/automation_alert.py @@ -32,9 +32,9 @@ def lazy_import(): from gooddata_api_client.model.alert_afm import AlertAfm - from gooddata_api_client.model.automation_alert_condition import AutomationAlertCondition + from gooddata_api_client.model.alert_condition import AlertCondition globals()['AlertAfm'] = AlertAfm - globals()['AutomationAlertCondition'] = AutomationAlertCondition + globals()['AlertCondition'] = AlertCondition class AutomationAlert(ModelNormal): @@ -102,7 +102,7 @@ def openapi_types(): """ lazy_import() return { - 'condition': (AutomationAlertCondition,), # noqa: E501 + 'condition': (AlertCondition,), # noqa: E501 'execution': (AlertAfm,), # noqa: E501 'interval': (str,), # noqa: E501 'trigger': (str,), # noqa: E501 @@ -131,7 +131,7 @@ def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E50 """AutomationAlert - a model defined in OpenAPI Args: - condition (AutomationAlertCondition): + condition (AlertCondition): execution (AlertAfm): Keyword Args: @@ -224,7 +224,7 @@ def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 """AutomationAlert - a model defined in OpenAPI Args: - condition (AutomationAlertCondition): + condition (AlertCondition): execution (AlertAfm): Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/automation_notification.py b/gooddata-api-client/gooddata_api_client/model/automation_notification.py index 5abe385de..d200d3b2a 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_notification.py +++ b/gooddata-api-client/gooddata_api_client/model/automation_notification.py @@ -64,6 +64,9 @@ class AutomationNotification(ModelComposed): """ allowed_values = { + ('type',): { + 'AUTOMATION': "AUTOMATION", + }, } validations = { @@ -92,8 +95,8 @@ def openapi_types(): """ lazy_import() return { - 'content': (WebhookMessage,), # noqa: E501 'type': (str,), # noqa: E501 + 'content': (WebhookMessage,), # noqa: E501 } @cached_property @@ -105,8 +108,8 @@ def discriminator(): return {'type': val} attribute_map = { - 'content': 'content', # noqa: E501 'type': 'type', # noqa: E501 + 'content': 'content', # noqa: E501 } read_only_vars = { @@ -118,8 +121,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """AutomationNotification - a model defined in OpenAPI Keyword Args: + type (str): defaults to "AUTOMATION", must be one of ["AUTOMATION", ] # noqa: E501 content (WebhookMessage): - type (str): _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. @@ -152,6 +155,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "AUTOMATION") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -223,8 +227,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 """AutomationNotification - a model defined in OpenAPI Keyword Args: + type (str): defaults to "AUTOMATION", must be one of ["AUTOMATION", ] # noqa: E501 content (WebhookMessage): - type (str): _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. @@ -257,6 +261,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "AUTOMATION") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) diff --git a/gooddata-api-client/gooddata_api_client/model/bounded_filter.py b/gooddata-api-client/gooddata_api_client/model/bounded_filter.py index 476d6cbca..b6b6c1874 100644 --- a/gooddata-api-client/gooddata_api_client/model/bounded_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/bounded_filter.py @@ -57,24 +57,45 @@ class BoundedFilter(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/cache_retention.py b/gooddata-api-client/gooddata_api_client/model/cache_retention.py new file mode 100644 index 000000000..2a435eb0e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/cache_retention.py @@ -0,0 +1,339 @@ +""" + 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.cache_retention_schedule import CacheRetentionSchedule + from gooddata_api_client.model.indefinite_cache_retention import IndefiniteCacheRetention + from gooddata_api_client.model.schedule_cache_retention import ScheduleCacheRetention + from gooddata_api_client.model.validity_period_cache_retention import ValidityPeriodCacheRetention + globals()['CacheRetentionSchedule'] = CacheRetentionSchedule + globals()['IndefiniteCacheRetention'] = IndefiniteCacheRetention + globals()['ScheduleCacheRetention'] = ScheduleCacheRetention + globals()['ValidityPeriodCacheRetention'] = ValidityPeriodCacheRetention + + +class CacheRetention(ModelComposed): + """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',): { + 'SCHEDULE': "SCHEDULE", + }, + } + + 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 = True + + @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 { + 'type': (str,), # noqa: E501 + 'validity_period': (str,), # noqa: E501 + 'schedule': (CacheRetentionSchedule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'validity_period': 'validityPeriod', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CacheRetention - 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,) + type (str): The cache retention type.. [optional] if omitted the server will use the default value of "SCHEDULE" # noqa: E501 + validity_period (str): How long the cached results stay valid after they were computed.. [optional] # noqa: E501 + schedule (CacheRetentionSchedule): [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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CacheRetention - 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,) + type (str): The cache retention type.. [optional] if omitted the server will use the default value of "SCHEDULE" # noqa: E501 + validity_period (str): How long the cached results stay valid after they were computed.. [optional] # noqa: E501 + schedule (CacheRetentionSchedule): [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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + IndefiniteCacheRetention, + ScheduleCacheRetention, + ValidityPeriodCacheRetention, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/cache_retention_schedule.py b/gooddata-api-client/gooddata_api_client/model/cache_retention_schedule.py new file mode 100644 index 000000000..ce7369c6c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/cache_retention_schedule.py @@ -0,0 +1,274 @@ +""" + 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 CacheRetentionSchedule(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 { + 'cron': (str,), # noqa: E501 + 'timezone': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cron': 'cron', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, cron, *args, **kwargs): # noqa: E501 + """CacheRetentionSchedule - a model defined in OpenAPI + + Args: + cron (str): Cron expression determining when the cached results expire. + + 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,) + timezone (str, none_type): Timezone the cron expression is evaluated in. Defaults to UTC when not set.. [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.cron = cron + 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, cron, *args, **kwargs): # noqa: E501 + """CacheRetentionSchedule - a model defined in OpenAPI + + Args: + cron (str): Cron expression determining when the cached results expire. + + 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,) + timezone (str, none_type): Timezone the cron expression is evaluated in. Defaults to UTC when not set.. [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.cron = cron + 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_parameter_content.py b/gooddata-api-client/gooddata_api_client/model/calendar_definition.py similarity index 87% rename from gooddata-api-client/gooddata_api_client/model/declarative_parameter_content.py rename to gooddata-api-client/gooddata_api_client/model/calendar_definition.py index ac065b540..608b680a4 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_parameter_content.py +++ b/gooddata-api-client/gooddata_api_client/model/calendar_definition.py @@ -31,15 +31,15 @@ def lazy_import(): - 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()['NumberParameterDefinition'] = NumberParameterDefinition - globals()['StringConstraints'] = StringConstraints - globals()['StringParameterDefinition'] = StringParameterDefinition + from gooddata_api_client.model.calendar_table_reference import CalendarTableReference + from gooddata_api_client.model.custom_calendar_definition import CustomCalendarDefinition + from gooddata_api_client.model.fiscal_year_calendar_definition import FiscalYearCalendarDefinition + globals()['CalendarTableReference'] = CalendarTableReference + globals()['CustomCalendarDefinition'] = CustomCalendarDefinition + globals()['FiscalYearCalendarDefinition'] = FiscalYearCalendarDefinition -class DeclarativeParameterContent(ModelComposed): +class CalendarDefinition(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -64,9 +64,6 @@ class DeclarativeParameterContent(ModelComposed): """ allowed_values = { - ('type',): { - 'STRING': "STRING", - }, } validations = { @@ -95,28 +92,26 @@ def openapi_types(): """ lazy_import() return { - 'type': (str,), # noqa: E501 - 'constraints': (StringConstraints,), # noqa: E501 - 'default_value': (str,), # noqa: E501 + 'data_source_tables': ({str: (CalendarTableReference,)},), # noqa: E501 + 'month_offset': (int,), # noqa: E501 } @cached_property def discriminator(): lazy_import() val = { - 'NUMBER': NumberParameterDefinition, - 'NumberParameterDefinition': NumberParameterDefinition, - 'STRING': StringParameterDefinition, - 'StringParameterDefinition': StringParameterDefinition, + 'CustomCalendarDefinition': CustomCalendarDefinition, + 'FiscalYearCalendarDefinition': FiscalYearCalendarDefinition, + 'custom': CustomCalendarDefinition, + 'fiscalYear': FiscalYearCalendarDefinition, } if not val: return None return {'type': val} attribute_map = { - 'type': 'type', # noqa: E501 - 'constraints': 'constraints', # noqa: E501 - 'default_value': 'defaultValue', # noqa: E501 + 'data_source_tables': 'dataSourceTables', # noqa: E501 + 'month_offset': 'monthOffset', # noqa: E501 } read_only_vars = { @@ -125,10 +120,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeParameterContent - a model defined in OpenAPI + """CalendarDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # 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. @@ -159,11 +153,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + data_source_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [optional] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -232,10 +225,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeParameterContent - a model defined in OpenAPI + """CalendarDefinition - a model defined in OpenAPI Keyword Args: - type (str): The parameter type.. defaults to "STRING", must be one of ["STRING", ] # 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. @@ -266,11 +258,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - constraints (StringConstraints): [optional] # noqa: E501 - default_value (str): [optional] # noqa: E501 + data_source_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [optional] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [optional] # noqa: E501 """ - type = kwargs.get('type', "STRING") _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,7 +331,7 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - NumberParameterDefinition, - StringParameterDefinition, + CustomCalendarDefinition, + FiscalYearCalendarDefinition, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/calendar_granularity.py b/gooddata-api-client/gooddata_api_client/model/calendar_granularity.py new file mode 100644 index 000000000..1327fa0ce --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/calendar_granularity.py @@ -0,0 +1,321 @@ +""" + 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 CalendarGranularity(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',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", + 'MINUTE': "MINUTE", + 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", + 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", + 'DAY_OF_WEEK': "DAY_OF_WEEK", + 'DAY_OF_MONTH': "DAY_OF_MONTH", + 'DAY_OF_QUARTER': "DAY_OF_QUARTER", + 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", + 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", + 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", + 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", + 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", + 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", + 'FISCAL_YEAR': "FISCAL_YEAR", + }, + } + + validations = { + ('prefix',): { + 'max_length': 255, + }, + } + + @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 + 'prefix': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'granularity': 'granularity', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, granularity, prefix, *args, **kwargs): # noqa: E501 + """CalendarGranularity - a model defined in OpenAPI + + Args: + granularity (str): Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. + prefix (str): Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. + + 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.granularity = granularity + self.prefix = prefix + 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, prefix, *args, **kwargs): # noqa: E501 + """CalendarGranularity - a model defined in OpenAPI + + Args: + granularity (str): Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. + prefix (str): Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. + + 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.granularity = granularity + self.prefix = prefix + 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/calendar_table_reference.py b/gooddata-api-client/gooddata_api_client/model/calendar_table_reference.py new file mode 100644 index 000000000..96f7d44d1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/calendar_table_reference.py @@ -0,0 +1,279 @@ +""" + 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 CalendarTableReference(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 = { + ('version',): { + 'max_length': 255, + }, + } + + @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 { + 'path': ([str],), # noqa: E501 + 'version': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'path': 'path', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, path, version, *args, **kwargs): # noqa: E501 + """CalendarTableReference - a model defined in OpenAPI + + Args: + path ([str]): Path to the fiscal calendar table. + version (str): Version of the fiscal calendar table structure. + + 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.path = path + self.version = version + 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, path, version, *args, **kwargs): # noqa: E501 + """CalendarTableReference - a model defined in OpenAPI + + Args: + path ([str]): Path to the fiscal calendar table. + version (str): Version of the fiscal calendar table structure. + + 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.path = path + self.version = version + 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/certification_info.py b/gooddata-api-client/gooddata_api_client/model/certification_info.py new file mode 100644 index 000000000..a66b1c74b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/certification_info.py @@ -0,0 +1,274 @@ +""" + 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 CertificationInfo(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 { + 'status': (str,), # noqa: E501 + 'certification_message': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status': 'status', # noqa: E501 + 'certification_message': 'certificationMessage', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501 + """CertificationInfo - a model defined in OpenAPI + + Args: + status (str): Certification status, e.g. CERTIFIED. + + 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,) + certification_message (str): Optional message describing the certification.. [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.status = status + 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, status, *args, **kwargs): # noqa: E501 + """CertificationInfo - a model defined in OpenAPI + + Args: + status (str): Certification status, e.g. CERTIFIED. + + 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,) + certification_message (str): Optional message describing the certification.. [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.status = status + 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/change_analysis_params.py b/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py index 4f6465cef..3be205599 100644 --- a/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py @@ -32,10 +32,10 @@ def lazy_import(): from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner + from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.measure_item import MeasureItem globals()['AttributeItem'] = AttributeItem - globals()['ChangeAnalysisParamsFiltersInner'] = ChangeAnalysisParamsFiltersInner + globals()['FilterDefinition'] = FilterDefinition globals()['MeasureItem'] = MeasureItem @@ -95,7 +95,7 @@ def openapi_types(): 'analyzed_period': (str,), # noqa: E501 'attributes': ([AttributeItem],), # noqa: E501 'date_attribute': (AttributeItem,), # noqa: E501 - 'filters': ([ChangeAnalysisParamsFiltersInner],), # noqa: E501 + 'filters': ([FilterDefinition],), # noqa: E501 'measure': (MeasureItem,), # noqa: E501 'measure_title': (str,), # noqa: E501 'reference_period': (str,), # noqa: E501 @@ -132,7 +132,7 @@ def _from_openapi_data(cls, analyzed_period, attributes, date_attribute, filters analyzed_period (str): The analyzed time period attributes ([AttributeItem]): Attributes to analyze for significant changes date_attribute (AttributeItem): - filters ([ChangeAnalysisParamsFiltersInner]): Optional filters to apply + filters ([FilterDefinition]): Optional filters to apply measure (MeasureItem): measure_title (str): The title of the measure being analyzed reference_period (str): The reference time period @@ -235,7 +235,7 @@ def __init__(self, analyzed_period, attributes, date_attribute, filters, measure analyzed_period (str): The analyzed time period attributes ([AttributeItem]): Attributes to analyze for significant changes date_attribute (AttributeItem): - filters ([ChangeAnalysisParamsFiltersInner]): Optional filters to apply + filters ([FilterDefinition]): Optional filters to apply measure (MeasureItem): measure_title (str): The title of the measure being analyzed reference_period (str): The reference time period diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py deleted file mode 100644 index d9da67d55..000000000 --- a/gooddata-api-client/gooddata_api_client/model/change_analysis_params_filters_inner.py +++ /dev/null @@ -1,388 +0,0 @@ -""" - 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.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter - from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter - from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter - from gooddata_api_client.model.comparison_measure_value_filter_comparison_measure_value_filter import ComparisonMeasureValueFilterComparisonMeasureValueFilter - from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter - from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure - from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition - from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline - 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.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter - from gooddata_api_client.model.range_measure_value_filter_range_measure_value_filter import RangeMeasureValueFilterRangeMeasureValueFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter - from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter - globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter - globals()['AbstractMeasureValueFilter'] = AbstractMeasureValueFilter - globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter - globals()['ComparisonMeasureValueFilterComparisonMeasureValueFilter'] = ComparisonMeasureValueFilterComparisonMeasureValueFilter - globals()['CompoundMeasureValueFilterCompoundMeasureValueFilter'] = CompoundMeasureValueFilterCompoundMeasureValueFilter - globals()['FilterDefinitionForSimpleMeasure'] = FilterDefinitionForSimpleMeasure - globals()['InlineFilterDefinition'] = InlineFilterDefinition - globals()['InlineFilterDefinitionInline'] = InlineFilterDefinitionInline - globals()['MatchAttributeFilterMatchAttributeFilter'] = MatchAttributeFilterMatchAttributeFilter - globals()['NegativeAttributeFilterNegativeAttributeFilter'] = NegativeAttributeFilterNegativeAttributeFilter - globals()['PositiveAttributeFilterPositiveAttributeFilter'] = PositiveAttributeFilterPositiveAttributeFilter - globals()['RangeMeasureValueFilterRangeMeasureValueFilter'] = RangeMeasureValueFilterRangeMeasureValueFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter - globals()['RelativeDateFilterRelativeDateFilter'] = RelativeDateFilterRelativeDateFilter - - -class ChangeAnalysisParamsFiltersInner(ModelComposed): - """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 { - 'comparison_measure_value_filter': (ComparisonMeasureValueFilterComparisonMeasureValueFilter,), # noqa: E501 - 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 - 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 - 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 - 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 - 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 - 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 - 'positive_attribute_filter': (PositiveAttributeFilterPositiveAttributeFilter,), # noqa: E501 - 'match_attribute_filter': (MatchAttributeFilterMatchAttributeFilter,), # noqa: E501 - 'inline': (InlineFilterDefinitionInline,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'comparison_measure_value_filter': 'comparisonMeasureValueFilter', # noqa: E501 - 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 - 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 - 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 - 'relative_date_filter': 'relativeDateFilter', # noqa: E501 - 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 - 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 - 'positive_attribute_filter': 'positiveAttributeFilter', # noqa: E501 - 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 - 'inline': 'inline', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ChangeAnalysisParamsFiltersInner - 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,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [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 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [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', ()) - - 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """ChangeAnalysisParamsFiltersInner - 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,) - comparison_measure_value_filter (ComparisonMeasureValueFilterComparisonMeasureValueFilter): [optional] # noqa: E501 - range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # noqa: E501 - compound_measure_value_filter (CompoundMeasureValueFilterCompoundMeasureValueFilter): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 - absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [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 - positive_attribute_filter (PositiveAttributeFilterPositiveAttributeFilter): [optional] # noqa: E501 - match_attribute_filter (MatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 - inline (InlineFilterDefinitionInline): [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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - AbstractMeasureValueFilter, - FilterDefinitionForSimpleMeasure, - InlineFilterDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_request.py b/gooddata-api-client/gooddata_api_client/model/change_analysis_request.py index 5d724e567..f81ba7307 100644 --- a/gooddata-api-client/gooddata_api_client/model/change_analysis_request.py +++ b/gooddata-api-client/gooddata_api_client/model/change_analysis_request.py @@ -32,10 +32,10 @@ def lazy_import(): from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner + from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.measure_item import MeasureItem globals()['AttributeItem'] = AttributeItem - globals()['ChangeAnalysisParamsFiltersInner'] = ChangeAnalysisParamsFiltersInner + globals()['FilterDefinition'] = FilterDefinition globals()['MeasureItem'] = MeasureItem @@ -99,7 +99,7 @@ def openapi_types(): 'attributes': ([AttributeItem],), # noqa: E501 'aux_measures': ([MeasureItem],), # noqa: E501 'exclude_tags': ([str],), # noqa: E501 - 'filters': ([ChangeAnalysisParamsFiltersInner],), # noqa: E501 + 'filters': ([FilterDefinition],), # noqa: E501 'include_tags': ([str],), # noqa: E501 'use_smart_attribute_selection': (bool,), # noqa: E501 } @@ -172,7 +172,7 @@ def _from_openapi_data(cls, analyzed_period, date_attribute, measure, reference_ attributes ([AttributeItem]): Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.. [optional] # noqa: E501 aux_measures ([MeasureItem]): Auxiliary measures. [optional] # noqa: E501 exclude_tags ([str]): Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.. [optional] # noqa: E501 - filters ([ChangeAnalysisParamsFiltersInner]): Optional filters to apply.. [optional] # noqa: E501 + filters ([FilterDefinition]): Optional filters to apply.. [optional] # noqa: E501 include_tags ([str]): Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.. [optional] # noqa: E501 use_smart_attribute_selection (bool): Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.. [optional] if omitted the server will use the default value of False # noqa: E501 """ @@ -273,7 +273,7 @@ def __init__(self, analyzed_period, date_attribute, measure, reference_period, * attributes ([AttributeItem]): Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.. [optional] # noqa: E501 aux_measures ([MeasureItem]): Auxiliary measures. [optional] # noqa: E501 exclude_tags ([str]): Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.. [optional] # noqa: E501 - filters ([ChangeAnalysisParamsFiltersInner]): Optional filters to apply.. [optional] # noqa: E501 + filters ([FilterDefinition]): Optional filters to apply.. [optional] # noqa: E501 include_tags ([str]): Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.. [optional] # noqa: E501 use_smart_attribute_selection (bool): Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.. [optional] if omitted the server will use the default value of False # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/column_partition_config.py b/gooddata-api-client/gooddata_api_client/model/column_partition_config.py index f1bcb6e53..d2ee4e282 100644 --- a/gooddata-api-client/gooddata_api_client/model/column_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/column_partition_config.py @@ -56,6 +56,9 @@ class ColumnPartitionConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'COLUMN': "column", + }, } validations = { @@ -83,6 +86,7 @@ def openapi_types(): """ return { 'columns': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -92,6 +96,7 @@ def discriminator(): attribute_map = { 'columns': 'columns', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -108,6 +113,7 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 columns ([str]): Columns to partition by. Keyword Args: + type (str): defaults to "column", must be one of ["column", ] # 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. @@ -140,6 +146,7 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "column") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -170,6 +177,7 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.columns = columns + 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 \ @@ -197,6 +205,7 @@ def __init__(self, columns, *args, **kwargs): # noqa: E501 columns ([str]): Columns to partition by. Keyword Args: + type (str): defaults to "column", must be one of ["column", ] # 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. @@ -229,6 +238,7 @@ def __init__(self, columns, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "column") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -257,6 +267,7 @@ def __init__(self, columns, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.columns = columns + 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py index c3786dc65..2129d4cf3 100644 --- a/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py @@ -90,9 +90,9 @@ def openapi_types(): """ lazy_import() return { - 'conditions': ([MeasureValueCondition],), # noqa: E501 'measure': (AfmIdentifier,), # noqa: E501 'apply_on_result': (bool,), # noqa: E501 + 'conditions': ([MeasureValueCondition],), # noqa: E501 'dimensionality': ([AfmIdentifier],), # noqa: E501 'local_identifier': (str,), # noqa: E501 'treat_null_values_as': (float,), # noqa: E501 @@ -104,9 +104,9 @@ def discriminator(): attribute_map = { - 'conditions': 'conditions', # noqa: E501 'measure': 'measure', # noqa: E501 'apply_on_result': 'applyOnResult', # noqa: E501 + 'conditions': 'conditions', # noqa: E501 'dimensionality': 'dimensionality', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 'treat_null_values_as': 'treatNullValuesAs', # noqa: E501 @@ -119,11 +119,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, measure, *args, **kwargs): # noqa: E501 """CompoundMeasureValueFilterCompoundMeasureValueFilter - a model defined in OpenAPI Args: - conditions ([MeasureValueCondition]): List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. measure (AfmIdentifier): Keyword Args: @@ -158,6 +157,7 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 + conditions ([MeasureValueCondition]): List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.. [optional] # noqa: E501 dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 @@ -192,7 +192,6 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.conditions = conditions self.measure = measure for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -214,11 +213,10 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 + def __init__(self, measure, *args, **kwargs): # noqa: E501 """CompoundMeasureValueFilterCompoundMeasureValueFilter - a model defined in OpenAPI Args: - conditions ([MeasureValueCondition]): List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned. measure (AfmIdentifier): Keyword Args: @@ -253,6 +251,7 @@ def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 + conditions ([MeasureValueCondition]): List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.. [optional] # noqa: E501 dimensionality ([AfmIdentifier]): References to the attributes to be used when filtering.. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 treat_null_values_as (float): A value that will be substituted for null values in the metric for the comparisons.. [optional] # noqa: E501 @@ -285,7 +284,6 @@ def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.conditions = conditions self.measure = measure for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/convert_geo_file_request.py b/gooddata-api-client/gooddata_api_client/model/convert_geo_file_request.py index 5bf5c5176..3a4752440 100644 --- a/gooddata-api-client/gooddata_api_client/model/convert_geo_file_request.py +++ b/gooddata-api-client/gooddata_api_client/model/convert_geo_file_request.py @@ -59,6 +59,9 @@ class ConvertGeoFileRequest(ModelNormal): } validations = { + ('location',): { + 'min_length': 1, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py index 2ea1e2152..c68e9daa6 100644 --- a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py +++ b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py @@ -32,13 +32,13 @@ def lazy_import(): from gooddata_api_client.model.column_expression import ColumnExpression - from gooddata_api_client.model.distribution_config import DistributionConfig - from gooddata_api_client.model.key_config import KeyConfig - from gooddata_api_client.model.partition_config import PartitionConfig + from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig + from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig + from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig globals()['ColumnExpression'] = ColumnExpression - globals()['DistributionConfig'] = DistributionConfig - globals()['KeyConfig'] = KeyConfig - globals()['PartitionConfig'] = PartitionConfig + globals()['CreatePipeTableRequestDistributionConfig'] = CreatePipeTableRequestDistributionConfig + globals()['CreatePipeTableRequestKeyConfig'] = CreatePipeTableRequestKeyConfig + globals()['CreatePipeTableRequestPartitionConfig'] = CreatePipeTableRequestPartitionConfig class CreatePipeTableRequest(ModelNormal): @@ -100,10 +100,10 @@ def openapi_types(): 'aggregation_overrides': ({str: (str,)},), # noqa: E501 'column_expressions': ({str: (ColumnExpression,)},), # noqa: E501 'column_overrides': ({str: (str,)},), # noqa: E501 - 'distribution_config': (DistributionConfig,), # noqa: E501 - 'key_config': (KeyConfig,), # noqa: E501 + 'distribution_config': (CreatePipeTableRequestDistributionConfig,), # noqa: E501 + 'key_config': (CreatePipeTableRequestKeyConfig,), # noqa: E501 'max_varchar_length': (int,), # noqa: E501 - 'partition_config': (PartitionConfig,), # noqa: E501 + 'partition_config': (CreatePipeTableRequestPartitionConfig,), # noqa: E501 'polling_interval_seconds': (int,), # noqa: E501 'table_properties': ({str: (str,)},), # noqa: E501 } @@ -177,10 +177,10 @@ def _from_openapi_data(cls, path_prefix, source_storage_name, table_name, *args, aggregation_overrides ({str: (str,)}): Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.. [optional] # noqa: E501 column_expressions ({str: (ColumnExpression,)}): Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).. [optional] # noqa: E501 column_overrides ({str: (str,)}): Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.. [optional] # noqa: E501 - distribution_config (DistributionConfig): [optional] # noqa: E501 - key_config (KeyConfig): [optional] # noqa: E501 + distribution_config (CreatePipeTableRequestDistributionConfig): [optional] # noqa: E501 + key_config (CreatePipeTableRequestKeyConfig): [optional] # noqa: E501 max_varchar_length (int): Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.. [optional] # noqa: E501 - partition_config (PartitionConfig): [optional] # noqa: E501 + partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 or null = use server default.. [optional] # noqa: E501 table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.. [optional] # noqa: E501 """ @@ -279,10 +279,10 @@ def __init__(self, path_prefix, source_storage_name, table_name, *args, **kwargs aggregation_overrides ({str: (str,)}): Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.. [optional] # noqa: E501 column_expressions ({str: (ColumnExpression,)}): Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).. [optional] # noqa: E501 column_overrides ({str: (str,)}): Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.. [optional] # noqa: E501 - distribution_config (DistributionConfig): [optional] # noqa: E501 - key_config (KeyConfig): [optional] # noqa: E501 + distribution_config (CreatePipeTableRequestDistributionConfig): [optional] # noqa: E501 + key_config (CreatePipeTableRequestKeyConfig): [optional] # noqa: E501 max_varchar_length (int): Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.. [optional] # noqa: E501 - partition_config (PartitionConfig): [optional] # noqa: E501 + partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 or null = use server default.. [optional] # noqa: E501 table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py similarity index 96% rename from gooddata-api-client/gooddata_api_client/model/pipe_table_distribution_config.py rename to gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py index b3c9a993f..bf6028314 100644 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py @@ -37,7 +37,7 @@ def lazy_import(): globals()['RandomDistributionConfig'] = RandomDistributionConfig -class PipeTableDistributionConfig(ModelComposed): +class CreatePipeTableRequestDistributionConfig(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,6 +62,9 @@ class PipeTableDistributionConfig(ModelComposed): """ allowed_values = { + ('type',): { + 'RANDOM': "random", + }, } validations = { @@ -95,6 +98,7 @@ def openapi_types(): return { 'buckets': (int,), # noqa: E501 'columns': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -105,6 +109,7 @@ def discriminator(): attribute_map = { 'buckets': 'buckets', # noqa: E501 'columns': 'columns', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -113,7 +118,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PipeTableDistributionConfig - a model defined in OpenAPI + """CreatePipeTableRequestDistributionConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -148,6 +153,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "random" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -218,7 +224,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """PipeTableDistributionConfig - a model defined in OpenAPI + """CreatePipeTableRequestDistributionConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -253,6 +259,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "random" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table_key_config.py b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_key_config.py similarity index 96% rename from gooddata-api-client/gooddata_api_client/model/pipe_table_key_config.py rename to gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_key_config.py index 9ef904a79..2d422e918 100644 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_key_config.py @@ -41,7 +41,7 @@ def lazy_import(): globals()['UniqueKeyConfig'] = UniqueKeyConfig -class PipeTableKeyConfig(ModelComposed): +class CreatePipeTableRequestKeyConfig(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -66,6 +66,9 @@ class PipeTableKeyConfig(ModelComposed): """ allowed_values = { + ('type',): { + 'UNIQUE': "unique", + }, } validations = { @@ -95,6 +98,7 @@ def openapi_types(): lazy_import() return { 'columns': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -104,6 +108,7 @@ def discriminator(): attribute_map = { 'columns': 'columns', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -112,7 +117,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PipeTableKeyConfig - a model defined in OpenAPI + """CreatePipeTableRequestKeyConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -146,6 +151,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "unique" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -216,7 +222,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """PipeTableKeyConfig - a model defined in OpenAPI + """CreatePipeTableRequestKeyConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -250,6 +256,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "unique" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table_partition_config.py b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_partition_config.py similarity index 96% rename from gooddata-api-client/gooddata_api_client/model/pipe_table_partition_config.py rename to gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_partition_config.py index e002e8e4c..19be4da1d 100644 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_partition_config.py @@ -39,7 +39,7 @@ def lazy_import(): globals()['TimeSlicePartitionConfig'] = TimeSlicePartitionConfig -class PipeTablePartitionConfig(ModelComposed): +class CreatePipeTableRequestPartitionConfig(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -64,6 +64,9 @@ class PipeTablePartitionConfig(ModelComposed): """ allowed_values = { + ('type',): { + 'TIMESLICE': "timeSlice", + }, ('unit',): { 'YEAR': "year", 'QUARTER': "quarter", @@ -108,6 +111,7 @@ def openapi_types(): lazy_import() return { 'columns': ([str],), # noqa: E501 + 'type': (str,), # noqa: E501 'column': (str,), # noqa: E501 'unit': (str,), # noqa: E501 'slices': (int,), # noqa: E501 @@ -120,6 +124,7 @@ def discriminator(): attribute_map = { 'columns': 'columns', # noqa: E501 + 'type': 'type', # noqa: E501 'column': 'column', # noqa: E501 'unit': 'unit', # noqa: E501 'slices': 'slices', # noqa: E501 @@ -131,7 +136,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PipeTablePartitionConfig - a model defined in OpenAPI + """CreatePipeTableRequestPartitionConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -165,6 +170,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) columns ([str]): Columns to partition by.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "timeSlice" # noqa: E501 column (str): Column to partition on.. [optional] # noqa: E501 unit (str): Date/time unit for partition granularity. [optional] # noqa: E501 slices (int): How many units per slice.. [optional] # noqa: E501 @@ -238,7 +244,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """PipeTablePartitionConfig - a model defined in OpenAPI + """CreatePipeTableRequestPartitionConfig - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -272,6 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) columns ([str]): Columns to partition by.. [optional] # noqa: E501 + type (str): [optional] if omitted the server will use the default value of "timeSlice" # noqa: E501 column (str): Column to partition on.. [optional] # noqa: E501 unit (str): Date/time unit for partition granularity. [optional] # noqa: E501 slices (int): How many units per slice.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py index 880d3ba1d..3fddd8d92 100644 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py @@ -35,14 +35,12 @@ def lazy_import(): from gooddata_api_client.model.attribute_positive_filter import AttributePositiveFilter from gooddata_api_client.model.date_absolute_filter import DateAbsoluteFilter from gooddata_api_client.model.date_relative_filter import DateRelativeFilter - from gooddata_api_client.model.ranking_filter import RankingFilter - from gooddata_api_client.model.ranking_filter_ranking_filter import RankingFilterRankingFilter + from gooddata_api_client.model.gen_ai_ranking_filter import GenAiRankingFilter globals()['AttributeNegativeFilter'] = AttributeNegativeFilter globals()['AttributePositiveFilter'] = AttributePositiveFilter globals()['DateAbsoluteFilter'] = DateAbsoluteFilter globals()['DateRelativeFilter'] = DateRelativeFilter - globals()['RankingFilter'] = RankingFilter - globals()['RankingFilterRankingFilter'] = RankingFilterRankingFilter + globals()['GenAiRankingFilter'] = GenAiRankingFilter class CreatedVisualizationFiltersInner(ModelComposed): @@ -71,26 +69,51 @@ class CreatedVisualizationFiltersInner(ModelComposed): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, + ('operator',): { + 'TOP': "TOP", + 'BOTTOM': "BOTTOM", + }, } validations = { @@ -119,13 +142,16 @@ def openapi_types(): """ lazy_import() return { + 'dimensionality': ([str],), # noqa: E501 'exclude': ([str],), # noqa: E501 'using': (str,), # noqa: E501 'include': ([str],), # noqa: E501 '_from': (int,), # noqa: E501 'to': (int,), # noqa: E501 'granularity': (str,), # noqa: E501 - 'ranking_filter': (RankingFilterRankingFilter,), # noqa: E501 + 'measures': ([str],), # noqa: E501 + 'operator': (str,), # noqa: E501 + 'value': (int,), # noqa: E501 } @cached_property @@ -134,13 +160,16 @@ def discriminator(): attribute_map = { + 'dimensionality': 'dimensionality', # noqa: E501 'exclude': 'exclude', # noqa: E501 'using': 'using', # noqa: E501 'include': 'include', # noqa: E501 '_from': 'from', # noqa: E501 'to': 'to', # noqa: E501 'granularity': 'granularity', # noqa: E501 - 'ranking_filter': 'rankingFilter', # noqa: E501 + 'measures': 'measures', # noqa: E501 + 'operator': 'operator', # noqa: E501 + 'value': 'value', # noqa: E501 } read_only_vars = { @@ -182,13 +211,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + dimensionality ([str]): [optional] # noqa: E501 exclude ([str]): [optional] # noqa: E501 using (str): [optional] # noqa: E501 include ([str]): [optional] # noqa: E501 _from (int): [optional] # noqa: E501 to (int): [optional] # noqa: E501 granularity (str): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 + measures ([str]): [optional] # noqa: E501 + operator (str): [optional] # noqa: E501 + value (int): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -292,13 +324,16 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + dimensionality ([str]): [optional] # noqa: E501 exclude ([str]): [optional] # noqa: E501 using (str): [optional] # noqa: E501 include ([str]): [optional] # noqa: E501 _from (int): [optional] # noqa: E501 to (int): [optional] # noqa: E501 granularity (str): [optional] # noqa: E501 - ranking_filter (RankingFilterRankingFilter): [optional] # noqa: E501 + measures ([str]): [optional] # noqa: E501 + operator (str): [optional] # noqa: E501 + value (int): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -374,6 +409,6 @@ def _composed_schemas(): AttributePositiveFilter, DateAbsoluteFilter, DateRelativeFilter, - RankingFilter, + GenAiRankingFilter, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py b/gooddata-api-client/gooddata_api_client/model/custom_calendar_definition.py similarity index 86% rename from gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py rename to gooddata-api-client/gooddata_api_client/model/custom_calendar_definition.py index 5005ad275..7af857040 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert_condition.py +++ b/gooddata-api-client/gooddata_api_client/model/custom_calendar_definition.py @@ -31,25 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.anomaly_detection import AnomalyDetection - from gooddata_api_client.model.anomaly_detection_wrapper import AnomalyDetectionWrapper - from gooddata_api_client.model.comparison import Comparison - from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper - from gooddata_api_client.model.range import Range - from gooddata_api_client.model.range_wrapper import RangeWrapper - from gooddata_api_client.model.relative import Relative - from gooddata_api_client.model.relative_wrapper import RelativeWrapper - globals()['AnomalyDetection'] = AnomalyDetection - globals()['AnomalyDetectionWrapper'] = AnomalyDetectionWrapper - globals()['Comparison'] = Comparison - globals()['ComparisonWrapper'] = ComparisonWrapper - globals()['Range'] = Range - globals()['RangeWrapper'] = RangeWrapper - globals()['Relative'] = Relative - globals()['RelativeWrapper'] = RelativeWrapper - - -class AutomationAlertCondition(ModelComposed): + from gooddata_api_client.model.calendar_table_reference import CalendarTableReference + from gooddata_api_client.model.custom_calendar_definition_all_of import CustomCalendarDefinitionAllOf + globals()['CalendarTableReference'] = CalendarTableReference + globals()['CustomCalendarDefinitionAllOf'] = CustomCalendarDefinitionAllOf + + +class CustomCalendarDefinition(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -74,6 +62,9 @@ class AutomationAlertCondition(ModelComposed): """ allowed_values = { + ('type',): { + 'CUSTOM': "custom", + }, } validations = { @@ -102,10 +93,8 @@ def openapi_types(): """ lazy_import() return { - 'anomaly': (AnomalyDetection,), # noqa: E501 - 'comparison': (Comparison,), # noqa: E501 - 'range': (Range,), # noqa: E501 - 'relative': (Relative,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'data_source_tables': ({str: (CalendarTableReference,)},), # noqa: E501 } @cached_property @@ -114,10 +103,8 @@ def discriminator(): attribute_map = { - 'anomaly': 'anomaly', # noqa: E501 - 'comparison': 'comparison', # noqa: E501 - 'range': 'range', # noqa: E501 - 'relative': 'relative', # noqa: E501 + 'type': 'type', # noqa: E501 + 'data_source_tables': 'dataSourceTables', # noqa: E501 } read_only_vars = { @@ -126,9 +113,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AutomationAlertCondition - a model defined in OpenAPI + """CustomCalendarDefinition - a model defined in OpenAPI Keyword Args: + type (str): defaults to "custom", must be one of ["custom", ] # noqa: E501 + data_source_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID. _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. @@ -159,12 +148,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - anomaly (AnomalyDetection): [optional] # noqa: E501 - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 """ + type = kwargs.get('type', "custom") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -233,9 +219,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """AutomationAlertCondition - a model defined in OpenAPI + """CustomCalendarDefinition - a model defined in OpenAPI Keyword Args: + type (str): defaults to "custom", must be one of ["custom", ] # noqa: E501 + data_source_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID. _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. @@ -266,12 +254,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - anomaly (AnomalyDetection): [optional] # noqa: E501 - comparison (Comparison): [optional] # noqa: E501 - range (Range): [optional] # noqa: E501 - relative (Relative): [optional] # noqa: E501 """ + type = kwargs.get('type', "custom") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -339,11 +324,8 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ + CustomCalendarDefinitionAllOf, ], 'oneOf': [ - AnomalyDetectionWrapper, - ComparisonWrapper, - RangeWrapper, - RelativeWrapper, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/custom_calendar_definition_all_of.py b/gooddata-api-client/gooddata_api_client/model/custom_calendar_definition_all_of.py new file mode 100644 index 000000000..646d9e446 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/custom_calendar_definition_all_of.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 + + +def lazy_import(): + from gooddata_api_client.model.calendar_table_reference import CalendarTableReference + globals()['CalendarTableReference'] = CalendarTableReference + + +class CustomCalendarDefinitionAllOf(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 { + 'data_source_tables': ({str: (CalendarTableReference,)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_source_tables': 'dataSourceTables', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CustomCalendarDefinitionAllOf - 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_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [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 + """CustomCalendarDefinitionAllOf - 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_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [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/dashboard_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py index d0b9de0dd..289798ce9 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_date_filter_date_filter.py @@ -88,9 +88,30 @@ class DashboardDateFilterDateFilter(ModelNormal): 'GDC.TIME.HOUR_IN_DAY': "GDC.time.hour_in_day", 'GDC.TIME.MINUTE': "GDC.time.minute", 'GDC.TIME.MINUTE_IN_HOUR': "GDC.time.minute_in_hour", + 'GDC.TIME.MINUTE_IN_DAY': "GDC.time.minute_in_day", + 'GDC.TIME.SECOND': "GDC.time.second", + 'GDC.TIME.SECOND_IN_MINUTE': "GDC.time.second_in_minute", + 'GDC.TIME.SECOND_IN_DAY': "GDC.time.second_in_day", + 'GDC.TIME.FISCAL_WEEK': "GDC.time.fiscal_week", 'GDC.TIME.FISCAL_MONTH': "GDC.time.fiscal_month", 'GDC.TIME.FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'GDC.TIME.FISCAL_SEMESTER': "GDC.time.fiscal_semester", 'GDC.TIME.FISCAL_YEAR': "GDC.time.fiscal_year", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_WEEK': "GDC.time.fiscal_day_in_fiscal_week", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_MONTH': "GDC.time.fiscal_day_in_fiscal_month", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_QUARTER': "GDC.time.fiscal_day_in_fiscal_quarter", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_SEMESTER': "GDC.time.fiscal_day_in_fiscal_semester", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_YEAR': "GDC.time.fiscal_day_in_fiscal_year", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_MONTH': "GDC.time.fiscal_week_in_fiscal_month", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_QUARTER': "GDC.time.fiscal_week_in_fiscal_quarter", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_SEMESTER': "GDC.time.fiscal_week_in_fiscal_semester", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_YEAR': "GDC.time.fiscal_week_in_fiscal_year", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_QUARTER': "GDC.time.fiscal_month_in_fiscal_quarter", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_SEMESTER': "GDC.time.fiscal_month_in_fiscal_semester", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_YEAR': "GDC.time.fiscal_month_in_fiscal_year", + 'GDC.TIME.FISCAL_QUARTER_IN_FISCAL_SEMESTER': "GDC.time.fiscal_quarter_in_fiscal_semester", + 'GDC.TIME.FISCAL_QUARTER_IN_FISCAL_YEAR': "GDC.time.fiscal_quarter_in_fiscal_year", + 'GDC.TIME.FISCAL_SEMESTER_IN_FISCAL_YEAR': "GDC.time.fiscal_semester_in_fiscal_year", }, ('type',): { 'RELATIVE': "relative", diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_measure_value_filter_dashboard_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/dashboard_measure_value_filter_dashboard_measure_value_filter.py index 08ff25145..7ed165083 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_measure_value_filter_dashboard_measure_value_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_measure_value_filter_dashboard_measure_value_filter.py @@ -90,8 +90,8 @@ def openapi_types(): """ lazy_import() return { - 'conditions': ([DashboardCompoundConditionItem],), # noqa: E501 'measure': (IdentifierRef,), # noqa: E501 + 'conditions': ([DashboardCompoundConditionItem],), # noqa: E501 'dimensionality': ([IdentifierRef],), # noqa: E501 'local_identifier': (str,), # noqa: E501 'title': (str,), # noqa: E501 @@ -103,8 +103,8 @@ def discriminator(): attribute_map = { - 'conditions': 'conditions', # noqa: E501 'measure': 'measure', # noqa: E501 + 'conditions': 'conditions', # noqa: E501 'dimensionality': 'dimensionality', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 'title': 'title', # noqa: E501 @@ -117,11 +117,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, measure, *args, **kwargs): # noqa: E501 """DashboardMeasureValueFilterDashboardMeasureValueFilter - a model defined in OpenAPI Args: - conditions ([DashboardCompoundConditionItem]): measure (IdentifierRef): Keyword Args: @@ -155,6 +154,7 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditions ([DashboardCompoundConditionItem]): [optional] # noqa: E501 dimensionality ([IdentifierRef]): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 title (str): [optional] # noqa: E501 @@ -189,7 +189,6 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.conditions = conditions self.measure = measure for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -211,11 +210,10 @@ def _from_openapi_data(cls, conditions, measure, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 + def __init__(self, measure, *args, **kwargs): # noqa: E501 """DashboardMeasureValueFilterDashboardMeasureValueFilter - a model defined in OpenAPI Args: - conditions ([DashboardCompoundConditionItem]): measure (IdentifierRef): Keyword Args: @@ -249,6 +247,7 @@ def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditions ([DashboardCompoundConditionItem]): [optional] # noqa: E501 dimensionality ([IdentifierRef]): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 title (str): [optional] # noqa: E501 @@ -281,7 +280,6 @@ def __init__(self, conditions, measure, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.conditions = conditions self.measure = measure for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py index a71a99b59..4637693db 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request.py @@ -33,10 +33,12 @@ def lazy_import(): from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings from gooddata_api_client.model.dashboard_filter import DashboardFilter - from gooddata_api_client.model.dashboard_parameter_value import DashboardParameterValue + from gooddata_api_client.model.execution_settings import ExecutionSettings + from gooddata_api_client.model.parameter_value import ParameterValue globals()['DashboardExportSettings'] = DashboardExportSettings globals()['DashboardFilter'] = DashboardFilter - globals()['DashboardParameterValue'] = DashboardParameterValue + globals()['ExecutionSettings'] = ExecutionSettings + globals()['ParameterValue'] = ParameterValue class DashboardTabularExportRequest(ModelNormal): @@ -102,9 +104,10 @@ def openapi_types(): 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 'dashboard_filters_override': ([DashboardFilter],), # noqa: E501 - 'dashboard_parameters_override': ([DashboardParameterValue],), # noqa: E501 + 'dashboard_parameters_override': ([ParameterValue],), # noqa: E501 'dashboard_tabs_filters_overrides': ({str: ([DashboardFilter],)},), # noqa: E501 - 'dashboard_tabs_parameters_overrides': ({str: ([DashboardParameterValue],)},), # noqa: E501 + 'dashboard_tabs_parameters_overrides': ({str: ([ParameterValue],)},), # noqa: E501 + 'execution_settings': (ExecutionSettings,), # noqa: E501 'settings': (DashboardExportSettings,), # noqa: E501 'widget_ids': ([str],), # noqa: E501 } @@ -121,6 +124,7 @@ def discriminator(): 'dashboard_parameters_override': 'dashboardParametersOverride', # noqa: E501 'dashboard_tabs_filters_overrides': 'dashboardTabsFiltersOverrides', # noqa: E501 'dashboard_tabs_parameters_overrides': 'dashboardTabsParametersOverrides', # noqa: E501 + 'execution_settings': 'executionSettings', # noqa: E501 'settings': 'settings', # noqa: E501 'widget_ids': 'widgetIds', # noqa: E501 } @@ -171,9 +175,10 @@ def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - dashboard_parameters_override ([DashboardParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 + dashboard_parameters_override ([ParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 dashboard_tabs_filters_overrides ({str: ([DashboardFilter],)}): Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.. [optional] # noqa: E501 - dashboard_tabs_parameters_overrides ({str: ([DashboardParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + dashboard_tabs_parameters_overrides ({str: ([ParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 settings (DashboardExportSettings): [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ @@ -268,9 +273,10 @@ def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - dashboard_parameters_override ([DashboardParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 + dashboard_parameters_override ([ParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 dashboard_tabs_filters_overrides ({str: ([DashboardFilter],)}): Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.. [optional] # noqa: E501 - dashboard_tabs_parameters_overrides ({str: ([DashboardParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + dashboard_tabs_parameters_overrides ({str: ([ParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 settings (DashboardExportSettings): [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py index efba7dca3..0c57b7b6e 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py +++ b/gooddata-api-client/gooddata_api_client/model/dashboard_tabular_export_request_v2.py @@ -33,10 +33,12 @@ def lazy_import(): from gooddata_api_client.model.dashboard_export_settings import DashboardExportSettings from gooddata_api_client.model.dashboard_filter import DashboardFilter - from gooddata_api_client.model.dashboard_parameter_value import DashboardParameterValue + from gooddata_api_client.model.execution_settings import ExecutionSettings + from gooddata_api_client.model.parameter_value import ParameterValue globals()['DashboardExportSettings'] = DashboardExportSettings globals()['DashboardFilter'] = DashboardFilter - globals()['DashboardParameterValue'] = DashboardParameterValue + globals()['ExecutionSettings'] = ExecutionSettings + globals()['ParameterValue'] = ParameterValue class DashboardTabularExportRequestV2(ModelNormal): @@ -103,9 +105,10 @@ def openapi_types(): 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 'dashboard_filters_override': ([DashboardFilter],), # noqa: E501 - 'dashboard_parameters_override': ([DashboardParameterValue],), # noqa: E501 + 'dashboard_parameters_override': ([ParameterValue],), # noqa: E501 'dashboard_tabs_filters_overrides': ({str: ([DashboardFilter],)},), # noqa: E501 - 'dashboard_tabs_parameters_overrides': ({str: ([DashboardParameterValue],)},), # noqa: E501 + 'dashboard_tabs_parameters_overrides': ({str: ([ParameterValue],)},), # noqa: E501 + 'execution_settings': (ExecutionSettings,), # noqa: E501 'settings': (DashboardExportSettings,), # noqa: E501 'widget_ids': ([str],), # noqa: E501 } @@ -123,6 +126,7 @@ def discriminator(): 'dashboard_parameters_override': 'dashboardParametersOverride', # noqa: E501 'dashboard_tabs_filters_overrides': 'dashboardTabsFiltersOverrides', # noqa: E501 'dashboard_tabs_parameters_overrides': 'dashboardTabsParametersOverrides', # noqa: E501 + 'execution_settings': 'executionSettings', # noqa: E501 'settings': 'settings', # noqa: E501 'widget_ids': 'widgetIds', # noqa: E501 } @@ -174,9 +178,10 @@ def _from_openapi_data(cls, dashboard_id, file_name, format, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - dashboard_parameters_override ([DashboardParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 + dashboard_parameters_override ([ParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 dashboard_tabs_filters_overrides ({str: ([DashboardFilter],)}): Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.. [optional] # noqa: E501 - dashboard_tabs_parameters_overrides ({str: ([DashboardParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + dashboard_tabs_parameters_overrides ({str: ([ParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 settings (DashboardExportSettings): [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ @@ -273,9 +278,10 @@ def __init__(self, dashboard_id, file_name, format, *args, **kwargs): # noqa: E through its discriminator because we passed in _visited_composed_classes = (Animal,) dashboard_filters_override ([DashboardFilter]): List of filters that will be used instead of the default dashboard filters.. [optional] # noqa: E501 - dashboard_parameters_override ([DashboardParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 + dashboard_parameters_override ([ParameterValue]): Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.. [optional] # noqa: E501 dashboard_tabs_filters_overrides ({str: ([DashboardFilter],)}): Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.. [optional] # noqa: E501 - dashboard_tabs_parameters_overrides ({str: ([DashboardParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + dashboard_tabs_parameters_overrides ({str: ([ParameterValue],)}): Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 settings (DashboardExportSettings): [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ 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 b08077872..bf72882a3 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/date_filter.py @@ -33,12 +33,16 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.absolute_granularity_date_filter import AbsoluteGranularityDateFilter + 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.relative_date_filter import RelativeDateFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilter'] = AbsoluteDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter + globals()['AbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilter + globals()['AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter globals()['AllTimeDateFilter'] = AllTimeDateFilter globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['RelativeDateFilter'] = RelativeDateFilter @@ -99,6 +103,7 @@ def openapi_types(): lazy_import() return { 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 + 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 } @@ -110,6 +115,7 @@ def discriminator(): attribute_map = { 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 + 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 } @@ -154,6 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ @@ -260,6 +267,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [optional] # noqa: E501 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 """ @@ -334,6 +342,7 @@ def _composed_schemas(): ], 'oneOf': [ AbsoluteDateFilter, + AbsoluteGranularityDateFilter, AllTimeDateFilter, RelativeDateFilter, ], diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py b/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py index 250e5587c..d37411d91 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py @@ -63,24 +63,45 @@ class DateRelativeFilter(ModelComposed): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py index 9d3be6a8f..947e4d48e 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py @@ -57,24 +57,45 @@ class DateRelativeFilterAllOf(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py b/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py index 204cc2aaa..0b64a88d2 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py @@ -56,6 +56,9 @@ class DateTruncPartitionConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'DATETRUNC': "dateTrunc", + }, ('unit',): { 'YEAR': "year", 'QUARTER': "quarter", @@ -95,6 +98,7 @@ def openapi_types(): """ return { 'column': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 'unit': (str,), # noqa: E501 } @@ -105,6 +109,7 @@ def discriminator(): attribute_map = { 'column': 'column', # noqa: E501 + 'type': 'type', # noqa: E501 'unit': 'unit', # noqa: E501 } @@ -123,6 +128,7 @@ def _from_openapi_data(cls, column, unit, *args, **kwargs): # noqa: E501 unit (str): Date/time unit for partition granularity Keyword Args: + type (str): defaults to "dateTrunc", must be one of ["dateTrunc", ] # 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. @@ -155,6 +161,7 @@ def _from_openapi_data(cls, column, unit, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "dateTrunc") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -185,6 +192,7 @@ def _from_openapi_data(cls, column, unit, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.column = column + self.type = type self.unit = unit for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -214,6 +222,7 @@ def __init__(self, column, unit, *args, **kwargs): # noqa: E501 unit (str): Date/time unit for partition granularity Keyword Args: + type (str): defaults to "dateTrunc", must be one of ["dateTrunc", ] # 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. @@ -246,6 +255,7 @@ def __init__(self, column, unit, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "dateTrunc") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -274,6 +284,7 @@ def __init__(self, column, unit, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.column = column + self.type = type self.unit = unit for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_calendar.py b/gooddata-api-client/gooddata_api_client/model/declarative_calendar.py new file mode 100644 index 000000000..d53cea6a5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_calendar.py @@ -0,0 +1,300 @@ +""" + 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.calendar_definition import CalendarDefinition + from gooddata_api_client.model.calendar_granularity import CalendarGranularity + globals()['CalendarDefinition'] = CalendarDefinition + globals()['CalendarGranularity'] = CalendarGranularity + + +class DeclarativeCalendar(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 = { + ('name',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + } + + @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 { + 'definition': (CalendarDefinition,), # noqa: E501 + 'enabled_granularities': ([CalendarGranularity],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'definition': 'definition', # noqa: E501 + 'enabled_granularities': 'enabledGranularities', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, definition, enabled_granularities, name, *args, **kwargs): # noqa: E501 + """DeclarativeCalendar - a model defined in OpenAPI + + Args: + definition (CalendarDefinition): + enabled_granularities ([CalendarGranularity]): Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy. + name (str): Calendar title. + + 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,) + description (str): Calendar description.. [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.definition = definition + self.enabled_granularities = enabled_granularities + 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, definition, enabled_granularities, name, *args, **kwargs): # noqa: E501 + """DeclarativeCalendar - a model defined in OpenAPI + + Args: + definition (CalendarDefinition): + enabled_granularities ([CalendarGranularity]): Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy. + name (str): Calendar title. + + 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,) + description (str): Calendar description.. [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.definition = definition + self.enabled_granularities = enabled_granularities + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py index 049f6b8b0..3777b4b7d 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py @@ -31,8 +31,10 @@ def lazy_import(): + from gooddata_api_client.model.cache_retention import CacheRetention from gooddata_api_client.model.declarative_data_source_permission import DeclarativeDataSourcePermission from gooddata_api_client.model.parameter import Parameter + globals()['CacheRetention'] = CacheRetention globals()['DeclarativeDataSourcePermission'] = DeclarativeDataSourcePermission globals()['Parameter'] = Parameter @@ -98,7 +100,7 @@ class DeclarativeDataSource(ModelNormal): 'TOKEN': "TOKEN", 'KEY_PAIR': "KEY_PAIR", 'CLIENT_SECRET': "CLIENT_SECRET", - 'ACCESS_TOKEN': "ACCESS_TOKEN", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", }, ('cache_strategy',): { 'ALWAYS': "ALWAYS", @@ -183,6 +185,7 @@ def openapi_types(): 'type': (str,), # noqa: E501 'alternative_data_source_id': (str, none_type,), # noqa: E501 'authentication_type': (str, none_type,), # noqa: E501 + 'cache_retention': (CacheRetention,), # noqa: E501 'cache_strategy': (str,), # noqa: E501 'client_id': (str,), # noqa: E501 'client_secret': (str,), # noqa: E501 @@ -210,6 +213,7 @@ def discriminator(): 'type': 'type', # noqa: E501 'alternative_data_source_id': 'alternativeDataSourceId', # noqa: E501 'authentication_type': 'authenticationType', # noqa: E501 + 'cache_retention': 'cacheRetention', # noqa: E501 'cache_strategy': 'cacheStrategy', # noqa: E501 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 @@ -274,6 +278,7 @@ def _from_openapi_data(cls, id, name, schema, type, *args, **kwargs): # noqa: E _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (CacheRetention): [optional] # noqa: E501 cache_strategy (str): Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached.. [optional] # noqa: E501 client_id (str): Id of client with permission to connect to the data source.. [optional] # noqa: E501 client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 @@ -384,6 +389,7 @@ def __init__(self, id, name, schema, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (CacheRetention): [optional] # noqa: E501 cache_strategy (str): Determines how the results coming from a particular datasource should be cached. - ALWAYS: The results from the datasource should be cached normally (the default). - NEVER: The results from the datasource should never be cached.. [optional] # noqa: E501 client_id (str): Id of client with permission to connect to the data source.. [optional] # noqa: E501 client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py index 7eb748b5e..1d6f0a8cc 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py @@ -61,24 +61,45 @@ class DeclarativeDateDataset(ModelNormal): allowed_values = { ('granularities',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py index 4a69b7a09..8f5488350 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['DeclarativeExportDefinitionRequestPayload'] = DeclarativeExportDefinitionRequestPayload + from gooddata_api_client.model.export_request import ExportRequest globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + globals()['ExportRequest'] = ExportRequest class DeclarativeExportDefinition(ModelNormal): @@ -120,7 +120,7 @@ def openapi_types(): 'description': (str,), # noqa: E501 'modified_at': (str, none_type,), # noqa: E501 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 - 'request_payload': (DeclarativeExportDefinitionRequestPayload,), # noqa: E501 + 'request_payload': (ExportRequest,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -191,7 +191,7 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 description (str): Export definition object description.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - request_payload (DeclarativeExportDefinitionRequestPayload): [optional] # noqa: E501 + request_payload (ExportRequest): [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ @@ -289,7 +289,7 @@ def __init__(self, id, title, *args, **kwargs): # noqa: E501 description (str): Export definition object description.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - request_payload (DeclarativeExportDefinitionRequestPayload): [optional] # noqa: E501 + request_payload (ExportRequest): [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py b/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py deleted file mode 100644 index 9fb69bc0a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_export_definition_request_payload.py +++ /dev/null @@ -1,369 +0,0 @@ -""" - 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.custom_override import CustomOverride - from gooddata_api_client.model.settings import Settings - from gooddata_api_client.model.tabular_export_request import TabularExportRequest - from gooddata_api_client.model.visual_export_request import VisualExportRequest - globals()['CustomOverride'] = CustomOverride - globals()['Settings'] = Settings - globals()['TabularExportRequest'] = TabularExportRequest - globals()['VisualExportRequest'] = VisualExportRequest - - -class DeclarativeExportDefinitionRequestPayload(ModelComposed): - """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 = { - ('format',): { - 'CSV': "CSV", - 'XLSX': "XLSX", - 'HTML': "HTML", - 'PDF': "PDF", - }, - } - - 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 { - 'custom_override': (CustomOverride,), # noqa: E501 - 'execution_result': (str,), # noqa: E501 - 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'related_dashboard_id': (str,), # noqa: E501 - 'settings': (Settings,), # noqa: E501 - 'visualization_object': (str,), # noqa: E501 - 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 - 'file_name': (str,), # noqa: E501 - 'format': (str,), # noqa: E501 - 'dashboard_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'custom_override': 'customOverride', # noqa: E501 - 'execution_result': 'executionResult', # noqa: E501 - 'metadata': 'metadata', # noqa: E501 - 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 - 'settings': 'settings', # noqa: E501 - 'visualization_object': 'visualizationObject', # noqa: E501 - 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 - 'file_name': 'fileName', # noqa: E501 - 'format': 'format', # noqa: E501 - 'dashboard_id': 'dashboardId', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionRequestPayload - 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,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - file_name (str): File name to be used for retrieving the pdf document.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [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', ()) - - 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeExportDefinitionRequestPayload - 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,) - custom_override (CustomOverride): [optional] # noqa: E501 - execution_result (str): Execution result identifier.. [optional] # noqa: E501 - metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 - related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 - settings (Settings): [optional] # noqa: E501 - visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 - visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 - file_name (str): File name to be used for retrieving the pdf document.. [optional] # noqa: E501 - format (str): Expected file format.. [optional] # noqa: E501 - dashboard_id (str): Dashboard identifier. [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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - TabularExportRequest, - VisualExportRequest, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py b/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py index 50a8d6fc9..7b99ebbbb 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_ldm.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.declarative_calendar import DeclarativeCalendar from gooddata_api_client.model.declarative_dataset import DeclarativeDataset from gooddata_api_client.model.declarative_dataset_extension import DeclarativeDatasetExtension from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset + globals()['DeclarativeCalendar'] = DeclarativeCalendar globals()['DeclarativeDataset'] = DeclarativeDataset globals()['DeclarativeDatasetExtension'] = DeclarativeDatasetExtension globals()['DeclarativeDateDataset'] = DeclarativeDateDataset @@ -92,6 +94,7 @@ def openapi_types(): """ lazy_import() return { + 'calendars': ({str: (DeclarativeCalendar,)},), # noqa: E501 'dataset_extensions': ([DeclarativeDatasetExtension],), # noqa: E501 'datasets': ([DeclarativeDataset],), # noqa: E501 'date_instances': ([DeclarativeDateDataset],), # noqa: E501 @@ -103,6 +106,7 @@ def discriminator(): attribute_map = { + 'calendars': 'calendars', # noqa: E501 'dataset_extensions': 'datasetExtensions', # noqa: E501 'datasets': 'datasets', # noqa: E501 'date_instances': 'dateInstances', # noqa: E501 @@ -149,6 +153,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + calendars ({str: (DeclarativeCalendar,)}): Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace.. [optional] # noqa: E501 dataset_extensions ([DeclarativeDatasetExtension]): An array containing extensions for datasets defined in parent workspaces.. [optional] # noqa: E501 datasets ([DeclarativeDataset]): An array containing datasets.. [optional] # noqa: E501 date_instances ([DeclarativeDateDataset]): An array containing date-related datasets.. [optional] # noqa: E501 @@ -237,6 +242,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + calendars ({str: (DeclarativeCalendar,)}): Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace.. [optional] # noqa: E501 dataset_extensions ([DeclarativeDatasetExtension]): An array containing extensions for datasets defined in parent workspaces.. [optional] # noqa: E501 datasets ([DeclarativeDataset]): An array containing datasets.. [optional] # noqa: E501 date_instances ([DeclarativeDateDataset]): An array containing date-related datasets.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py index bed7f24f4..8fc3004bc 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination - globals()['DeclarativeNotificationChannelDestination'] = DeclarativeNotificationChannelDestination + from gooddata_api_client.model.notification_channel_destination import NotificationChannelDestination + globals()['NotificationChannelDestination'] = NotificationChannelDestination class DeclarativeNotificationChannel(ModelNormal): @@ -131,7 +131,7 @@ def openapi_types(): 'custom_dashboard_url': (str,), # noqa: E501 'dashboard_link_visibility': (str,), # noqa: E501 'description': (str,), # noqa: E501 - 'destination': (DeclarativeNotificationChannelDestination,), # noqa: E501 + 'destination': (NotificationChannelDestination,), # noqa: E501 'destination_type': (str, none_type,), # noqa: E501 'in_platform_notification': (str,), # noqa: E501 'name': (str,), # noqa: E501 @@ -205,7 +205,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] if omitted the server will use the default value of "INTERNAL_ONLY" # noqa: E501 description (str): Description of a notification channel.. [optional] # noqa: E501 - destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 + destination (NotificationChannelDestination): [optional] # noqa: E501 destination_type (str, none_type): [optional] # noqa: E501 in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] if omitted the server will use the default value of "DISABLED" # noqa: E501 name (str): Name of a notification channel.. [optional] # noqa: E501 @@ -303,7 +303,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 custom_dashboard_url (str): Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate} . [optional] # noqa: E501 dashboard_link_visibility (str): Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link . [optional] if omitted the server will use the default value of "INTERNAL_ONLY" # noqa: E501 description (str): Description of a notification channel.. [optional] # noqa: E501 - destination (DeclarativeNotificationChannelDestination): [optional] # noqa: E501 + destination (NotificationChannelDestination): [optional] # noqa: E501 destination_type (str, none_type): [optional] # noqa: E501 in_platform_notification (str): In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications . [optional] if omitted the server will use the default value of "DISABLED" # noqa: E501 name (str): Name of a notification channel.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py b/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py deleted file mode 100644 index 0d4905d4d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/declarative_notification_channel_destination.py +++ /dev/null @@ -1,400 +0,0 @@ -""" - 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.default_smtp import DefaultSmtp - from gooddata_api_client.model.in_platform import InPlatform - from gooddata_api_client.model.smtp import Smtp - from gooddata_api_client.model.webhook import Webhook - globals()['DefaultSmtp'] = DefaultSmtp - globals()['InPlatform'] = InPlatform - globals()['Smtp'] = Smtp - globals()['Webhook'] = Webhook - - -class DeclarativeNotificationChannelDestination(ModelComposed): - """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 = { - ('port',): { - '25': 25, - '465': 465, - '587': 587, - '2525': 2525, - }, - ('type',): { - 'WEBHOOK': "WEBHOOK", - }, - } - - validations = { - ('has_secret_key',): { - }, - ('has_token',): { - }, - ('secret_key',): { - 'max_length': 10000, - }, - ('token',): { - 'max_length': 10000, - }, - ('url',): { - 'max_length': 255, - 'regex': { - 'pattern': r'https?\:\/\/.*', # 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 { - 'from_email': (str,), # noqa: E501 - 'from_email_name': (str,), # noqa: E501 - 'host': (str,), # noqa: E501 - 'password': (str,), # noqa: E501 - 'port': (int,), # noqa: E501 - 'username': (str,), # noqa: E501 - 'has_secret_key': (bool, none_type,), # noqa: E501 - 'has_token': (bool, none_type,), # noqa: E501 - 'secret_key': (str, none_type,), # noqa: E501 - 'token': (str, none_type,), # noqa: E501 - 'url': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'from_email': 'fromEmail', # noqa: E501 - 'from_email_name': 'fromEmailName', # noqa: E501 - 'host': 'host', # noqa: E501 - 'password': 'password', # noqa: E501 - 'port': 'port', # noqa: E501 - 'username': 'username', # noqa: E501 - 'has_secret_key': 'hasSecretKey', # noqa: E501 - 'has_token': 'hasToken', # noqa: E501 - 'secret_key': 'secretKey', # noqa: E501 - 'token': 'token', # noqa: E501 - 'url': 'url', # noqa: E501 - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - 'has_secret_key', # noqa: E501 - 'has_token', # noqa: E501 - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelDestination - 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,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_secret_key (bool, none_type): Flag indicating if webhook has a hmac secret key.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - secret_key (str, none_type): Hmac secret key for the webhook signature.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # 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', ()) - - 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """DeclarativeNotificationChannelDestination - 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,) - from_email (str): E-mail address to send notifications from.. [optional] if omitted the server will use the default value of no-reply@gooddata.com # noqa: E501 - from_email_name (str): An optional e-mail name to send notifications from.. [optional] if omitted the server will use the default value of "GoodData" # noqa: E501 - host (str): The SMTP server address.. [optional] # noqa: E501 - password (str): The SMTP server password.. [optional] # noqa: E501 - port (int): The SMTP server port.. [optional] # noqa: E501 - username (str): The SMTP server username.. [optional] # noqa: E501 - has_secret_key (bool, none_type): Flag indicating if webhook has a hmac secret key.. [optional] # noqa: E501 - has_token (bool, none_type): Flag indicating if webhook has a token.. [optional] # noqa: E501 - secret_key (str, none_type): Hmac secret key for the webhook signature.. [optional] # noqa: E501 - token (str, none_type): Bearer token for the webhook.. [optional] # noqa: E501 - url (str): The webhook URL.. [optional] # noqa: E501 - type (str): The destination type.. [optional] if omitted the server will use the default value of "WEBHOOK" # 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - DefaultSmtp, - InPlatform, - Smtp, - Webhook, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_parameter.py b/gooddata-api-client/gooddata_api_client/model/declarative_parameter.py index 1a7cd40ea..5b1d30682 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_parameter.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_parameter.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.declarative_parameter_content import DeclarativeParameterContent from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier - globals()['DeclarativeParameterContent'] = DeclarativeParameterContent + from gooddata_api_client.model.parameter_definition import ParameterDefinition globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + globals()['ParameterDefinition'] = ParameterDefinition class DeclarativeParameter(ModelNormal): @@ -113,7 +113,7 @@ def openapi_types(): """ lazy_import() return { - 'content': (DeclarativeParameterContent,), # noqa: E501 + 'content': (ParameterDefinition,), # noqa: E501 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 'created_at': (str, none_type,), # noqa: E501 @@ -152,7 +152,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 """DeclarativeParameter - a model defined in OpenAPI Args: - content (DeclarativeParameterContent): + content (ParameterDefinition): id (str): Parameter ID. title (str): Parameter title. @@ -251,7 +251,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 """DeclarativeParameter - a model defined in OpenAPI Args: - content (DeclarativeParameterContent): + content (ParameterDefinition): id (str): Parameter ID. title (str): Parameter title. 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 72dc46c00..eeada2029 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -87,6 +87,7 @@ class DeclarativeSetting(ModelNormal): 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", + 'DEFAULT_EXPORT_TEMPLATE': "DEFAULT_EXPORT_TEMPLATE", 'ENABLE_SNAPSHOT_EXPORT': "ENABLE_SNAPSHOT_EXPORT", 'AI_RATE_LIMIT': "AI_RATE_LIMIT", 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", @@ -107,6 +108,7 @@ class DeclarativeSetting(ModelNormal): 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", '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", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py index 00c85223c..f11ff7609 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace.py @@ -37,8 +37,11 @@ def lazy_import(): from gooddata_api_client.model.declarative_setting import DeclarativeSetting from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission from gooddata_api_client.model.declarative_user_data_filter import DeclarativeUserDataFilter + from gooddata_api_client.model.declarative_workspace_color_palette import DeclarativeWorkspaceColorPalette + from gooddata_api_client.model.declarative_workspace_export_template import DeclarativeWorkspaceExportTemplate from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel + from gooddata_api_client.model.declarative_workspace_theme import DeclarativeWorkspaceTheme from gooddata_api_client.model.workspace_data_source import WorkspaceDataSource from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier globals()['DeclarativeAutomation'] = DeclarativeAutomation @@ -47,8 +50,11 @@ def lazy_import(): globals()['DeclarativeSetting'] = DeclarativeSetting globals()['DeclarativeSingleWorkspacePermission'] = DeclarativeSingleWorkspacePermission globals()['DeclarativeUserDataFilter'] = DeclarativeUserDataFilter + globals()['DeclarativeWorkspaceColorPalette'] = DeclarativeWorkspaceColorPalette + globals()['DeclarativeWorkspaceExportTemplate'] = DeclarativeWorkspaceExportTemplate globals()['DeclarativeWorkspaceHierarchyPermission'] = DeclarativeWorkspaceHierarchyPermission globals()['DeclarativeWorkspaceModel'] = DeclarativeWorkspaceModel + globals()['DeclarativeWorkspaceTheme'] = DeclarativeWorkspaceTheme globals()['WorkspaceDataSource'] = WorkspaceDataSource globals()['WorkspaceIdentifier'] = WorkspaceIdentifier @@ -132,18 +138,22 @@ def openapi_types(): 'name': (str,), # noqa: E501 'automations': ([DeclarativeAutomation],), # noqa: E501 'cache_extra_limit': (int,), # noqa: E501 + 'color_palettes': ([DeclarativeWorkspaceColorPalette],), # noqa: E501 'custom_application_settings': ([DeclarativeCustomApplicationSetting],), # noqa: E501 'data_source': (WorkspaceDataSource,), # noqa: E501 'description': (str,), # noqa: E501 'early_access': (str,), # noqa: E501 'early_access_values': ([str],), # noqa: E501 + 'export_templates': ([DeclarativeWorkspaceExportTemplate],), # noqa: E501 'filter_views': ([DeclarativeFilterView],), # noqa: E501 'hierarchy_permissions': ([DeclarativeWorkspaceHierarchyPermission],), # noqa: E501 + 'managed': (bool,), # noqa: E501 'model': (DeclarativeWorkspaceModel,), # noqa: E501 'parent': (WorkspaceIdentifier,), # noqa: E501 'permissions': ([DeclarativeSingleWorkspacePermission],), # noqa: E501 'prefix': (str,), # noqa: E501 'settings': ([DeclarativeSetting],), # noqa: E501 + 'themes': ([DeclarativeWorkspaceTheme],), # noqa: E501 'user_data_filters': ([DeclarativeUserDataFilter],), # noqa: E501 } @@ -157,22 +167,27 @@ def discriminator(): 'name': 'name', # noqa: E501 'automations': 'automations', # noqa: E501 'cache_extra_limit': 'cacheExtraLimit', # noqa: E501 + 'color_palettes': 'colorPalettes', # noqa: E501 'custom_application_settings': 'customApplicationSettings', # noqa: E501 'data_source': 'dataSource', # noqa: E501 'description': 'description', # noqa: E501 'early_access': 'earlyAccess', # noqa: E501 'early_access_values': 'earlyAccessValues', # noqa: E501 + 'export_templates': 'exportTemplates', # noqa: E501 'filter_views': 'filterViews', # noqa: E501 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 + 'managed': 'managed', # noqa: E501 'model': 'model', # noqa: E501 'parent': 'parent', # noqa: E501 'permissions': 'permissions', # noqa: E501 'prefix': 'prefix', # noqa: E501 'settings': 'settings', # noqa: E501 + 'themes': 'themes', # noqa: E501 'user_data_filters': 'userDataFilters', # noqa: E501 } read_only_vars = { + 'managed', # noqa: E501 } _composed_schemas = {} @@ -219,18 +234,22 @@ def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) automations ([DeclarativeAutomation]): [optional] # noqa: E501 cache_extra_limit (int): Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.. [optional] # noqa: E501 + color_palettes ([DeclarativeWorkspaceColorPalette]): A list of workspace color palettes.. [optional] # noqa: E501 custom_application_settings ([DeclarativeCustomApplicationSetting]): A list of workspace custom settings.. [optional] # noqa: E501 data_source (WorkspaceDataSource): [optional] # noqa: E501 description (str): Description of the workspace. [optional] # noqa: E501 early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 + export_templates ([DeclarativeWorkspaceExportTemplate]): A list of workspace export templates.. [optional] # noqa: E501 filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 + managed (bool): Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled).. [optional] # noqa: E501 model (DeclarativeWorkspaceModel): [optional] # noqa: E501 parent (WorkspaceIdentifier): [optional] # noqa: E501 permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 prefix (str): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 settings ([DeclarativeSetting]): A list of workspace settings.. [optional] # noqa: E501 + themes ([DeclarativeWorkspaceTheme]): A list of workspace themes.. [optional] # noqa: E501 user_data_filters ([DeclarativeUserDataFilter]): A list of workspace user data filters.. [optional] # noqa: E501 """ @@ -325,18 +344,22 @@ def __init__(self, id, name, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) automations ([DeclarativeAutomation]): [optional] # noqa: E501 cache_extra_limit (int): Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.. [optional] # noqa: E501 + color_palettes ([DeclarativeWorkspaceColorPalette]): A list of workspace color palettes.. [optional] # noqa: E501 custom_application_settings ([DeclarativeCustomApplicationSetting]): A list of workspace custom settings.. [optional] # noqa: E501 data_source (WorkspaceDataSource): [optional] # noqa: E501 description (str): Description of the workspace. [optional] # noqa: E501 early_access (str): Early access defined on level Workspace. [optional] # noqa: E501 early_access_values ([str]): Early access defined on level Workspace. [optional] # noqa: E501 + export_templates ([DeclarativeWorkspaceExportTemplate]): A list of workspace export templates.. [optional] # noqa: E501 filter_views ([DeclarativeFilterView]): [optional] # noqa: E501 hierarchy_permissions ([DeclarativeWorkspaceHierarchyPermission]): [optional] # noqa: E501 + managed (bool): Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled).. [optional] # noqa: E501 model (DeclarativeWorkspaceModel): [optional] # noqa: E501 parent (WorkspaceIdentifier): [optional] # noqa: E501 permissions ([DeclarativeSingleWorkspacePermission]): [optional] # noqa: E501 prefix (str): Custom prefix of entity identifiers in workspace. [optional] # noqa: E501 settings ([DeclarativeSetting]): A list of workspace settings.. [optional] # noqa: E501 + themes ([DeclarativeWorkspaceTheme]): A list of workspace themes.. [optional] # noqa: E501 user_data_filters ([DeclarativeUserDataFilter]): A list of workspace user data filters.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_color_palette.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_color_palette.py new file mode 100644 index 000000000..bfa1c4a80 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_color_palette.py @@ -0,0 +1,291 @@ +""" + 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.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class DeclarativeWorkspaceColorPalette(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 = { + ('name',): { + 'max_length': 255, + }, + } + + @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 { + 'content': (JsonNode,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceColorPalette - a model defined in OpenAPI + + Args: + content (JsonNode): + 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,) + """ + + _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.content = content + 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, content, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceColorPalette - a model defined in OpenAPI + + Args: + content (JsonNode): + 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,) + """ + + _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.content = content + 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/declarative_workspace_export_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_export_template.py new file mode 100644 index 000000000..432c81ed3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_export_template.py @@ -0,0 +1,300 @@ +""" + 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.workspace_dashboard_slides_template import WorkspaceDashboardSlidesTemplate + from gooddata_api_client.model.workspace_widget_slides_template import WorkspaceWidgetSlidesTemplate + globals()['WorkspaceDashboardSlidesTemplate'] = WorkspaceDashboardSlidesTemplate + globals()['WorkspaceWidgetSlidesTemplate'] = WorkspaceWidgetSlidesTemplate + + +class DeclarativeWorkspaceExportTemplate(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 + }, + }, + ('name',): { + 'max_length': 255, + }, + } + + @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 + 'name': (str,), # noqa: E501 + 'dashboard_slides_template': (WorkspaceDashboardSlidesTemplate,), # noqa: E501 + 'widget_slides_template': (WorkspaceWidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceExportTemplate - a model defined in OpenAPI + + Args: + id (str): Identifier of a workspace export template + name (str): Name of a workspace export template. + + 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,) + dashboard_slides_template (WorkspaceDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (WorkspaceWidgetSlidesTemplate): [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.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, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceExportTemplate - a model defined in OpenAPI + + Args: + id (str): Identifier of a workspace export template + name (str): Name of a workspace export template. + + 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,) + dashboard_slides_template (WorkspaceDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (WorkspaceWidgetSlidesTemplate): [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.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_theme.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_theme.py new file mode 100644 index 000000000..2036564cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_theme.py @@ -0,0 +1,291 @@ +""" + 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.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class DeclarativeWorkspaceTheme(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 = { + ('name',): { + 'max_length': 255, + }, + } + + @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 { + 'content': (JsonNode,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceTheme - a model defined in OpenAPI + + Args: + content (JsonNode): + 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,) + """ + + _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.content = content + 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, content, id, name, *args, **kwargs): # noqa: E501 + """DeclarativeWorkspaceTheme - a model defined in OpenAPI + + Args: + content (JsonNode): + 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,) + """ + + _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.content = content + 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/duplicate_key_config.py b/gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py index c458f6103..9c32fcf43 100644 --- a/gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py @@ -56,6 +56,9 @@ class DuplicateKeyConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'DUPLICATE': "duplicate", + }, } validations = { @@ -82,6 +85,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'columns': ([str],), # noqa: E501 } @@ -91,6 +95,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'columns': 'columns', # noqa: E501 } @@ -104,7 +109,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """DuplicateKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "duplicate", must be one of ["duplicate", ] # 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. @@ -138,6 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "duplicate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -167,6 +176,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -190,7 +200,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """DuplicateKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "duplicate", must be one of ["duplicate", ] # 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. @@ -224,6 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "duplicate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -251,6 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request.py b/gooddata-api-client/gooddata_api_client/model/elements_request.py index 23ce93f91..3315b048f 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_request.py +++ b/gooddata-api-client/gooddata_api_client/model/elements_request.py @@ -111,6 +111,7 @@ def openapi_types(): 'filter_by': (FilterBy,), # noqa: E501 'pattern_filter': (str,), # noqa: E501 'sort_order': (str,), # noqa: E501 + 'timezone': (str,), # noqa: E501 'validate_by': ([ValidateByItem],), # noqa: E501 } @@ -130,6 +131,7 @@ def discriminator(): 'filter_by': 'filterBy', # noqa: E501 'pattern_filter': 'patternFilter', # noqa: E501 'sort_order': 'sortOrder', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 'validate_by': 'validateBy', # noqa: E501 } @@ -186,6 +188,7 @@ def _from_openapi_data(cls, label, *args, **kwargs): # noqa: E501 filter_by (FilterBy): [optional] # noqa: E501 pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 + timezone (str): Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.. [optional] # noqa: E501 validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 """ @@ -285,6 +288,7 @@ def __init__(self, label, *args, **kwargs): # noqa: E501 filter_by (FilterBy): [optional] # noqa: E501 pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 + timezone (str): Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.. [optional] # noqa: E501 validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/elements_response.py b/gooddata-api-client/gooddata_api_client/model/elements_response.py index 02466b7c3..789436833 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_response.py +++ b/gooddata-api-client/gooddata_api_client/model/elements_response.py @@ -67,24 +67,45 @@ class ElementsResponse(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py index e600cfa0e..5792e5066 100644 --- a/gooddata-api-client/gooddata_api_client/model/entitlements_request.py +++ b/gooddata-api-client/gooddata_api_client/model/entitlements_request.py @@ -90,6 +90,7 @@ class EntitlementsRequest(ModelNormal): 'AIKNOWLEDGESTORAGELIMIT': "AiKnowledgeStorageLimit", 'AIAGENTLIMIT': "AiAgentLimit", 'AIWORKSPACELIMIT': "AiWorkspaceLimit", + 'AIOBSERVABILITY': "AiObservability", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/execution_settings.py b/gooddata-api-client/gooddata_api_client/model/execution_settings.py index b7daddc02..051ede7ba 100644 --- a/gooddata-api-client/gooddata_api_client/model/execution_settings.py +++ b/gooddata-api-client/gooddata_api_client/model/execution_settings.py @@ -88,6 +88,7 @@ def openapi_types(): return { 'data_sampling_percentage': (float,), # noqa: E501 'timestamp': (datetime,), # noqa: E501 + 'timezone': (str,), # noqa: E501 } @cached_property @@ -98,6 +99,7 @@ def discriminator(): attribute_map = { 'data_sampling_percentage': 'dataSamplingPercentage', # noqa: E501 'timestamp': 'timestamp', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 } read_only_vars = { @@ -143,6 +145,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 + timezone (str): Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -230,6 +233,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) data_sampling_percentage (float): Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.. [optional] # noqa: E501 timestamp (datetime): Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.. [optional] # noqa: E501 + timezone (str): Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/export_request.py b/gooddata-api-client/gooddata_api_client/model/export_request.py index e848d04fe..d6d569eec 100644 --- a/gooddata-api-client/gooddata_api_client/model/export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/export_request.py @@ -32,13 +32,19 @@ def lazy_import(): from gooddata_api_client.model.custom_override import CustomOverride + from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode + from gooddata_api_client.model.parameter_value import ParameterValue from gooddata_api_client.model.settings import Settings + from gooddata_api_client.model.tabular_export_execution import TabularExportExecution from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest globals()['CustomOverride'] = CustomOverride + globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode + globals()['ParameterValue'] = ParameterValue globals()['Settings'] = Settings + globals()['TabularExportExecution'] = TabularExportExecution globals()['TabularExportRequest'] = TabularExportRequest globals()['VisualExportRequest'] = VisualExportRequest @@ -103,12 +109,16 @@ def openapi_types(): lazy_import() return { 'metadata': (JsonNode,), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 + 'execution_settings': (ExecutionSettings,), # noqa: E501 + 'executions': ([TabularExportExecution],), # noqa: E501 'related_dashboard_id': (str,), # noqa: E501 'settings': (Settings,), # noqa: E501 'visualization_object': (str,), # noqa: E501 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 + 'visualization_object_custom_parameters': ([ParameterValue],), # noqa: E501 'dashboard_id': (str,), # noqa: E501 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 @@ -121,12 +131,16 @@ def discriminator(): attribute_map = { 'metadata': 'metadata', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 + 'execution_settings': 'executionSettings', # noqa: E501 + 'executions': 'executions', # noqa: E501 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 'settings': 'settings', # noqa: E501 'visualization_object': 'visualizationObject', # noqa: E501 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 + 'visualization_object_custom_parameters': 'visualizationObjectCustomParameters', # noqa: E501 'dashboard_id': 'dashboardId', # noqa: E501 'file_name': 'fileName', # noqa: E501 'format': 'format', # noqa: E501 @@ -172,12 +186,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 format (str): Expected file format.. [optional] # noqa: E501 @@ -285,12 +303,16 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 format (str): Expected file format.. [optional] # noqa: E501 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 10f0bf243..c79f1f705 100644 --- a/gooddata-api-client/gooddata_api_client/model/failed_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/failed_operation.py @@ -64,6 +64,9 @@ class FailedOperation(ModelComposed): """ allowed_values = { + ('status',): { + 'FAILED': "failed", + }, ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", @@ -101,10 +104,10 @@ def openapi_types(): """ lazy_import() return { + 'status': (str,), # noqa: E501 'error': (OperationError,), # noqa: E501 'id': (str,), # noqa: E501 'kind': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 } @cached_property @@ -116,10 +119,10 @@ def discriminator(): return {'status': val} attribute_map = { + 'status': 'status', # noqa: E501 'error': 'error', # noqa: E501 'id': 'id', # noqa: E501 'kind': 'kind', # noqa: E501 - 'status': 'status', # noqa: E501 } read_only_vars = { @@ -131,10 +134,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """FailedOperation - a model defined in OpenAPI Keyword Args: + 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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. @@ -167,6 +170,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + status = kwargs.get('status', "failed") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -238,10 +242,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 """FailedOperation - a model defined in OpenAPI Keyword Args: + 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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. @@ -274,6 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + status = kwargs.get('status', "failed") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) 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 9ee434e47..763e05e17 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter_definition.py +++ b/gooddata-api-client/gooddata_api_client/model/filter_definition.py @@ -33,6 +33,8 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.absolute_granularity_date_filter import AbsoluteGranularityDateFilter + 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.comparison_measure_value_filter import ComparisonMeasureValueFilter @@ -55,6 +57,8 @@ def lazy_import(): from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter globals()['AbsoluteDateFilter'] = AbsoluteDateFilter globals()['AbsoluteDateFilterAbsoluteDateFilter'] = AbsoluteDateFilterAbsoluteDateFilter + globals()['AbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilter + globals()['AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter globals()['AllTimeDateFilter'] = AllTimeDateFilter globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['ComparisonMeasureValueFilter'] = ComparisonMeasureValueFilter @@ -136,6 +140,7 @@ def openapi_types(): 'range_measure_value_filter': (RangeMeasureValueFilterRangeMeasureValueFilter,), # noqa: E501 'compound_measure_value_filter': (CompoundMeasureValueFilterCompoundMeasureValueFilter,), # noqa: E501 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 + 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 @@ -155,6 +160,7 @@ def discriminator(): 'range_measure_value_filter': 'rangeMeasureValueFilter', # noqa: E501 'compound_measure_value_filter': 'compoundMeasureValueFilter', # noqa: E501 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 + 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 @@ -207,6 +213,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # 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 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 @@ -321,6 +328,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 range_measure_value_filter (RangeMeasureValueFilterRangeMeasureValueFilter): [optional] # 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 relative_date_filter (RelativeDateFilterRelativeDateFilter): [optional] # noqa: E501 all_time_date_filter (AllTimeDateFilterAllTimeDateFilter): [optional] # noqa: E501 negative_attribute_filter (NegativeAttributeFilterNegativeAttributeFilter): [optional] # noqa: E501 @@ -398,6 +406,7 @@ def _composed_schemas(): ], 'oneOf': [ AbsoluteDateFilter, + AbsoluteGranularityDateFilter, AllTimeDateFilter, ComparisonMeasureValueFilter, CompoundMeasureValueFilter, 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 a19bd8c5a..01e6c28ff 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 @@ -32,6 +32,7 @@ def lazy_import(): from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter + from gooddata_api_client.model.absolute_granularity_date_filter_absolute_granularity_date_filter import AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter from gooddata_api_client.model.attribute_filter import AttributeFilter from gooddata_api_client.model.date_filter import DateFilter @@ -40,6 +41,7 @@ def lazy_import(): 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 + globals()['AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter'] = AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter globals()['AllTimeDateFilterAllTimeDateFilter'] = AllTimeDateFilterAllTimeDateFilter globals()['AttributeFilter'] = AttributeFilter globals()['DateFilter'] = DateFilter @@ -103,6 +105,7 @@ def openapi_types(): lazy_import() return { 'absolute_date_filter': (AbsoluteDateFilterAbsoluteDateFilter,), # noqa: E501 + 'absolute_granularity_date_filter': (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter,), # noqa: E501 'relative_date_filter': (RelativeDateFilterRelativeDateFilter,), # noqa: E501 'all_time_date_filter': (AllTimeDateFilterAllTimeDateFilter,), # noqa: E501 'negative_attribute_filter': (NegativeAttributeFilterNegativeAttributeFilter,), # noqa: E501 @@ -117,6 +120,7 @@ def discriminator(): attribute_map = { 'absolute_date_filter': 'absoluteDateFilter', # noqa: E501 + 'absolute_granularity_date_filter': 'absoluteGranularityDateFilter', # noqa: E501 'relative_date_filter': 'relativeDateFilter', # noqa: E501 'all_time_date_filter': 'allTimeDateFilter', # noqa: E501 'negative_attribute_filter': 'negativeAttributeFilter', # noqa: E501 @@ -164,6 +168,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [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 @@ -273,6 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) absolute_date_filter (AbsoluteDateFilterAbsoluteDateFilter): [optional] # noqa: E501 + absolute_granularity_date_filter (AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter): [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/fiscal_year_calendar_definition.py b/gooddata-api-client/gooddata_api_client/model/fiscal_year_calendar_definition.py new file mode 100644 index 000000000..4e8ea5029 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/fiscal_year_calendar_definition.py @@ -0,0 +1,329 @@ +""" + 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.fiscal_year_calendar_definition_all_of import FiscalYearCalendarDefinitionAllOf + globals()['FiscalYearCalendarDefinitionAllOf'] = FiscalYearCalendarDefinitionAllOf + + +class FiscalYearCalendarDefinition(ModelComposed): + """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',): { + 'FISCALYEAR': "fiscalYear", + }, + } + + 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 { + 'type': (str,), # noqa: E501 + 'month_offset': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'month_offset': 'monthOffset', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FiscalYearCalendarDefinition - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "fiscalYear", must be one of ["fiscalYear", ] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year. + _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', "fiscalYear") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FiscalYearCalendarDefinition - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "fiscalYear", must be one of ["fiscalYear", ] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year. + _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', "fiscalYear") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + FiscalYearCalendarDefinitionAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/fiscal_year_calendar_definition_all_of.py b/gooddata-api-client/gooddata_api_client/model/fiscal_year_calendar_definition_all_of.py new file mode 100644 index 000000000..5e83b3b66 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/fiscal_year_calendar_definition_all_of.py @@ -0,0 +1,264 @@ +""" + 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 FiscalYearCalendarDefinitionAllOf(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 { + 'month_offset': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'month_offset': 'monthOffset', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FiscalYearCalendarDefinitionAllOf - 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,) + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [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 + """FiscalYearCalendarDefinitionAllOf - 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,) + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [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/gen_ai_ranking_filter.py b/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter.py new file mode 100644 index 000000000..459e0403d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter.py @@ -0,0 +1,339 @@ +""" + 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.filter import Filter + from gooddata_api_client.model.gen_ai_ranking_filter_all_of import GenAiRankingFilterAllOf + globals()['Filter'] = Filter + globals()['GenAiRankingFilterAllOf'] = GenAiRankingFilterAllOf + + +class GenAiRankingFilter(ModelComposed): + """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 = { + ('operator',): { + 'TOP': "TOP", + 'BOTTOM': "BOTTOM", + }, + } + + 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 { + 'measures': ([str],), # noqa: E501 + 'operator': (str,), # noqa: E501 + 'value': (int,), # noqa: E501 + 'dimensionality': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'measures': 'measures', # noqa: E501 + 'operator': 'operator', # noqa: E501 + 'value': 'value', # noqa: E501 + 'dimensionality': 'dimensionality', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GenAiRankingFilter - a model defined in OpenAPI + + Keyword Args: + measures ([str]): + operator (str): + value (int): + _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,) + dimensionality ([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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GenAiRankingFilter - a model defined in OpenAPI + + Keyword Args: + measures ([str]): + operator (str): + value (int): + _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,) + dimensionality ([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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + Filter, + GenAiRankingFilterAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py new file mode 100644 index 000000000..dc8a8267f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py @@ -0,0 +1,280 @@ +""" + 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 GenAiRankingFilterAllOf(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 = { + ('operator',): { + 'TOP': "TOP", + 'BOTTOM': "BOTTOM", + }, + } + + 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 { + 'dimensionality': ([str],), # noqa: E501 + 'measures': ([str],), # noqa: E501 + 'operator': (str,), # noqa: E501 + 'value': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dimensionality': 'dimensionality', # noqa: E501 + 'measures': 'measures', # noqa: E501 + 'operator': 'operator', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GenAiRankingFilterAllOf - 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,) + dimensionality ([str]): [optional] # noqa: E501 + measures ([str]): [optional] # noqa: E501 + operator (str): [optional] # noqa: E501 + value (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 + """GenAiRankingFilterAllOf - 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,) + dimensionality ([str]): [optional] # noqa: E501 + measures ([str]): [optional] # noqa: E501 + operator (str): [optional] # noqa: E501 + value (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/hash_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/hash_distribution_config.py index 2250e6d9d..f7605a7f7 100644 --- a/gooddata-api-client/gooddata_api_client/model/hash_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/hash_distribution_config.py @@ -56,6 +56,9 @@ class HashDistributionConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'HASH': "hash", + }, } validations = { @@ -85,6 +88,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'buckets': (int,), # noqa: E501 'columns': ([str],), # noqa: E501 } @@ -95,6 +99,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'buckets': 'buckets', # noqa: E501 'columns': 'columns', # noqa: E501 } @@ -109,7 +114,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """HashDistributionConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "hash", must be one of ["hash", ] # 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. @@ -144,6 +152,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "hash") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -173,6 +182,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -196,7 +206,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """HashDistributionConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "hash", must be one of ["hash", ] # 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. @@ -231,6 +244,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "hash") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -258,6 +272,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_ref.py b/gooddata-api-client/gooddata_api_client/model/identifier_ref.py index 260650773..638b97a6b 100644 --- a/gooddata-api-client/gooddata_api_client/model/identifier_ref.py +++ b/gooddata-api-client/gooddata_api_client/model/identifier_ref.py @@ -107,9 +107,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 """IdentifierRef - a model defined in OpenAPI + Args: + identifier (IdentifierRefIdentifier): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -141,7 +144,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - identifier (IdentifierRefIdentifier): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -173,6 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.identifier = identifier for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -193,9 +196,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 + def __init__(self, identifier, *args, **kwargs): # noqa: E501 """IdentifierRef - a model defined in OpenAPI + Args: + identifier (IdentifierRefIdentifier): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -227,7 +233,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - identifier (IdentifierRefIdentifier): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -257,6 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.identifier = identifier for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py b/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py index 9263c6aba..953a6b5ce 100644 --- a/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/identifier_ref_identifier.py @@ -81,6 +81,11 @@ class IdentifierRefIdentifier(ModelNormal): 'WORKSPACEDATAFILTER': "workspaceDataFilter", 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", 'FILTERVIEW': "filterView", + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + 'WORKSPACETHEME': "workspaceTheme", + 'WORKSPACECOLORPALETTE': "workspaceColorPalette", + 'FISCALCALENDAR': "fiscalCalendar", + 'FISCALCALENDARGRANULARITY': "fiscalCalendarGranularity", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/image_export_request.py b/gooddata-api-client/gooddata_api_client/model/image_export_request.py index 31b482ebd..ebc789ed4 100644 --- a/gooddata-api-client/gooddata_api_client/model/image_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/image_export_request.py @@ -100,6 +100,7 @@ def openapi_types(): 'format': (str,), # noqa: E501 'widget_ids': ([str],), # noqa: E501 'metadata': (JsonNode,), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 } @cached_property @@ -113,6 +114,7 @@ def discriminator(): 'format': 'format', # noqa: E501 'widget_ids': 'widgetIds', # noqa: E501 'metadata': 'metadata', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 } read_only_vars = { @@ -163,6 +165,7 @@ def _from_openapi_data(cls, dashboard_id, file_name, widget_ids, *args, **kwargs through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 """ format = kwargs.get('format', "PNG") @@ -260,6 +263,7 @@ def __init__(self, dashboard_id, file_name, widget_ids, *args, **kwargs): # noq through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 """ format = kwargs.get('format', "PNG") diff --git a/gooddata-api-client/gooddata_api_client/model/indefinite_cache_retention.py b/gooddata-api-client/gooddata_api_client/model/indefinite_cache_retention.py new file mode 100644 index 000000000..813faea61 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/indefinite_cache_retention.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 IndefiniteCacheRetention(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',): { + 'INDEFINITE': "INDEFINITE", + }, + } + + 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 + """IndefiniteCacheRetention - a model defined in OpenAPI + + Args: + + Keyword Args: + type (str): The cache retention type.. defaults to "INDEFINITE", must be one of ["INDEFINITE", ] # 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', "INDEFINITE") + _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 + """IndefiniteCacheRetention - a model defined in OpenAPI + + Args: + + Keyword Args: + type (str): The cache retention type.. defaults to "INDEFINITE", must be one of ["INDEFINITE", ] # 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', "INDEFINITE") + _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/insight_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py index aa9fdc674..2c0d5ee7f 100644 --- a/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py @@ -60,6 +60,9 @@ class InsightWidgetDescriptor(ModelNormal): """ allowed_values = { + ('widget_type',): { + 'INSIGHT': "insight", + }, } validations = { @@ -91,6 +94,7 @@ def openapi_types(): 'title': (str,), # noqa: E501 'visualization_id': (str,), # noqa: E501 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 'filters': ([FilterDefinition],), # noqa: E501 'result_id': (str,), # noqa: E501 } @@ -104,6 +108,7 @@ def discriminator(): 'title': 'title', # noqa: E501 'visualization_id': 'visualizationId', # noqa: E501 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 'filters': 'filters', # noqa: E501 'result_id': 'resultId', # noqa: E501 } @@ -124,6 +129,7 @@ def _from_openapi_data(cls, title, visualization_id, widget_id, *args, **kwargs) widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "insight", must be one of ["insight", ] # 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. @@ -158,6 +164,7 @@ def _from_openapi_data(cls, title, visualization_id, widget_id, *args, **kwargs) result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "insight") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -190,6 +197,7 @@ def _from_openapi_data(cls, title, visualization_id, widget_id, *args, **kwargs) self.title = title self.visualization_id = visualization_id self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -219,6 +227,7 @@ def __init__(self, title, visualization_id, widget_id, *args, **kwargs): # noqa widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "insight", must be one of ["insight", ] # 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. @@ -253,6 +262,7 @@ def __init__(self, title, visualization_id, widget_id, *args, **kwargs): # noqa result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "insight") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -283,6 +293,7 @@ def __init__(self, title, visualization_id, widget_id, *args, **kwargs): # noqa self.title = title self.visualization_id = visualization_id self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py index 84f9d4be6..047512f34 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py @@ -57,24 +57,45 @@ class JsonApiAttributeOutAttributes(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, ('sort_direction',): { diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py index 192ae7820..56875e668 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py @@ -31,7 +31,9 @@ def lazy_import(): + from gooddata_api_client.model.json_api_data_source_in_attributes_cache_retention import JsonApiDataSourceInAttributesCacheRetention from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner + globals()['JsonApiDataSourceInAttributesCacheRetention'] = JsonApiDataSourceInAttributesCacheRetention globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner @@ -90,6 +92,14 @@ class JsonApiDataSourceInAttributes(ModelNormal): 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", }, + ('authentication_type',): { + 'None': None, + 'USERNAME_PASSWORD': "USERNAME_PASSWORD", + 'TOKEN': "TOKEN", + 'KEY_PAIR': "KEY_PAIR", + 'CLIENT_SECRET': "CLIENT_SECRET", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", + }, ('cache_strategy',): { 'None': None, 'ALWAYS': "ALWAYS", @@ -167,6 +177,8 @@ def openapi_types(): 'schema': (str,), # noqa: E501 'type': (str,), # noqa: E501 'alternative_data_source_id': (str, none_type,), # noqa: E501 + 'authentication_type': (str, none_type,), # noqa: E501 + 'cache_retention': (JsonApiDataSourceInAttributesCacheRetention,), # noqa: E501 'cache_strategy': (str, none_type,), # noqa: E501 'client_id': (str, none_type,), # noqa: E501 'client_secret': (str, none_type,), # noqa: E501 @@ -190,6 +202,8 @@ def discriminator(): 'schema': 'schema', # noqa: E501 'type': 'type', # noqa: E501 'alternative_data_source_id': 'alternativeDataSourceId', # noqa: E501 + 'authentication_type': 'authenticationType', # noqa: E501 + 'cache_retention': 'cacheRetention', # noqa: E501 'cache_strategy': 'cacheStrategy', # noqa: E501 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 @@ -250,6 +264,8 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 + authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 @@ -355,6 +371,8 @@ def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 + authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_cache_retention.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_cache_retention.py new file mode 100644 index 000000000..f8981671e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes_cache_retention.py @@ -0,0 +1,339 @@ +""" + 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.cache_retention_schedule import CacheRetentionSchedule + from gooddata_api_client.model.indefinite_cache_retention import IndefiniteCacheRetention + from gooddata_api_client.model.schedule_cache_retention import ScheduleCacheRetention + from gooddata_api_client.model.validity_period_cache_retention import ValidityPeriodCacheRetention + globals()['CacheRetentionSchedule'] = CacheRetentionSchedule + globals()['IndefiniteCacheRetention'] = IndefiniteCacheRetention + globals()['ScheduleCacheRetention'] = ScheduleCacheRetention + globals()['ValidityPeriodCacheRetention'] = ValidityPeriodCacheRetention + + +class JsonApiDataSourceInAttributesCacheRetention(ModelComposed): + """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',): { + 'VALIDITY_PERIOD': "VALIDITY_PERIOD", + }, + } + + 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 = True + + @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 { + 'type': (str,), # noqa: E501 + 'schedule': (CacheRetentionSchedule,), # noqa: E501 + 'validity_period': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + 'validity_period': 'validityPeriod', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiDataSourceInAttributesCacheRetention - 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,) + type (str): The cache retention type.. [optional] if omitted the server will use the default value of "VALIDITY_PERIOD" # noqa: E501 + schedule (CacheRetentionSchedule): [optional] # noqa: E501 + validity_period (str): How long the cached results stay valid after they were computed.. [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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiDataSourceInAttributesCacheRetention - 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,) + type (str): The cache retention type.. [optional] if omitted the server will use the default value of "VALIDITY_PERIOD" # noqa: E501 + schedule (CacheRetentionSchedule): [optional] # noqa: E501 + validity_period (str): How long the cached results stay valid after they were computed.. [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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + IndefiniteCacheRetention, + ScheduleCacheRetention, + ValidityPeriodCacheRetention, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py index 7b7be8d33..d1871b2c4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py @@ -31,7 +31,9 @@ def lazy_import(): + from gooddata_api_client.model.json_api_data_source_in_attributes_cache_retention import JsonApiDataSourceInAttributesCacheRetention from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner + globals()['JsonApiDataSourceInAttributesCacheRetention'] = JsonApiDataSourceInAttributesCacheRetention globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner @@ -96,7 +98,7 @@ class JsonApiDataSourceOutAttributes(ModelNormal): 'TOKEN': "TOKEN", 'KEY_PAIR': "KEY_PAIR", 'CLIENT_SECRET': "CLIENT_SECRET", - 'ACCESS_TOKEN': "ACCESS_TOKEN", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", }, ('cache_strategy',): { 'None': None, @@ -161,10 +163,12 @@ def openapi_types(): 'type': (str,), # noqa: E501 'alternative_data_source_id': (str, none_type,), # noqa: E501 'authentication_type': (str, none_type,), # noqa: E501 + 'cache_retention': (JsonApiDataSourceInAttributesCacheRetention,), # noqa: E501 'cache_strategy': (str, none_type,), # noqa: E501 'client_id': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 'decoded_parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 + 'managed': (bool,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'url': (str, none_type,), # noqa: E501 'username': (str, none_type,), # noqa: E501 @@ -181,10 +185,12 @@ def discriminator(): 'type': 'type', # noqa: E501 'alternative_data_source_id': 'alternativeDataSourceId', # noqa: E501 'authentication_type': 'authenticationType', # noqa: E501 + 'cache_retention': 'cacheRetention', # noqa: E501 'cache_strategy': 'cacheStrategy', # noqa: E501 'client_id': 'clientId', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'decoded_parameters': 'decodedParameters', # noqa: E501 + 'managed': 'managed', # noqa: E501 'parameters': 'parameters', # noqa: E501 'url': 'url', # noqa: E501 'username': 'username', # noqa: E501 @@ -238,10 +244,12 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.. [optional] # noqa: E501 decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 + managed (bool): Whether the object is platform-managed and read-only.. [optional] # noqa: E501 parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 @@ -340,10 +348,12 @@ def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.. [optional] # noqa: E501 decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 + managed (bool): Whether the object is platform-managed and read-only.. [optional] # noqa: E501 parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Additional parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 url (str, none_type): The URL of the database providing the data for the data source.. [optional] # noqa: E501 username (str, none_type): The username to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py index 81a97fcbd..abded6072 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py @@ -31,7 +31,9 @@ def lazy_import(): + from gooddata_api_client.model.json_api_data_source_in_attributes_cache_retention import JsonApiDataSourceInAttributesCacheRetention from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner + globals()['JsonApiDataSourceInAttributesCacheRetention'] = JsonApiDataSourceInAttributesCacheRetention globals()['JsonApiDataSourceInAttributesParametersInner'] = JsonApiDataSourceInAttributesParametersInner @@ -60,6 +62,14 @@ class JsonApiDataSourcePatchAttributes(ModelNormal): """ allowed_values = { + ('authentication_type',): { + 'None': None, + 'USERNAME_PASSWORD': "USERNAME_PASSWORD", + 'TOKEN': "TOKEN", + 'KEY_PAIR': "KEY_PAIR", + 'CLIENT_SECRET': "CLIENT_SECRET", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", + }, ('cache_strategy',): { 'None': None, 'ALWAYS': "ALWAYS", @@ -164,6 +174,8 @@ def openapi_types(): lazy_import() return { 'alternative_data_source_id': (str, none_type,), # noqa: E501 + 'authentication_type': (str, none_type,), # noqa: E501 + 'cache_retention': (JsonApiDataSourceInAttributesCacheRetention,), # noqa: E501 'cache_strategy': (str, none_type,), # noqa: E501 'client_id': (str, none_type,), # noqa: E501 'client_secret': (str, none_type,), # noqa: E501 @@ -187,6 +199,8 @@ def discriminator(): attribute_map = { 'alternative_data_source_id': 'alternativeDataSourceId', # noqa: E501 + 'authentication_type': 'authenticationType', # noqa: E501 + 'cache_retention': 'cacheRetention', # noqa: E501 'cache_strategy': 'cacheStrategy', # noqa: E501 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 @@ -245,6 +259,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 + authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 @@ -345,6 +361,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) alternative_data_source_id (str, none_type): Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.. [optional] # noqa: E501 + authentication_type (str, none_type): Type of authentication used to connect to the database.. [optional] # noqa: E501 + cache_retention (JsonApiDataSourceInAttributesCacheRetention): [optional] # noqa: E501 cache_strategy (str, none_type): Determines how the results coming from a particular datasource should be cached.. [optional] # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py index ba5e8c5d0..9ee948298 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py @@ -32,13 +32,19 @@ def lazy_import(): from gooddata_api_client.model.custom_override import CustomOverride + from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode + from gooddata_api_client.model.parameter_value import ParameterValue from gooddata_api_client.model.settings import Settings + from gooddata_api_client.model.tabular_export_execution import TabularExportExecution from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest globals()['CustomOverride'] = CustomOverride + globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode + globals()['ParameterValue'] = ParameterValue globals()['Settings'] = Settings + globals()['TabularExportExecution'] = TabularExportExecution globals()['TabularExportRequest'] = TabularExportRequest globals()['VisualExportRequest'] = VisualExportRequest @@ -103,12 +109,16 @@ def openapi_types(): lazy_import() return { 'metadata': (JsonNode,), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 + 'execution_settings': (ExecutionSettings,), # noqa: E501 + 'executions': ([TabularExportExecution],), # noqa: E501 'related_dashboard_id': (str,), # noqa: E501 'settings': (Settings,), # noqa: E501 'visualization_object': (str,), # noqa: E501 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 + 'visualization_object_custom_parameters': ([ParameterValue],), # noqa: E501 'dashboard_id': (str,), # noqa: E501 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 @@ -121,12 +131,16 @@ def discriminator(): attribute_map = { 'metadata': 'metadata', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 + 'execution_settings': 'executionSettings', # noqa: E501 + 'executions': 'executions', # noqa: E501 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 'settings': 'settings', # noqa: E501 'visualization_object': 'visualizationObject', # noqa: E501 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 + 'visualization_object_custom_parameters': 'visualizationObjectCustomParameters', # noqa: E501 'dashboard_id': 'dashboardId', # noqa: E501 'file_name': 'fileName', # noqa: E501 'format': 'format', # noqa: E501 @@ -172,12 +186,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 format (str): Expected file format.. [optional] # noqa: E501 @@ -285,12 +303,16 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 file_name (str): Filename of downloaded file without extension.. [optional] # noqa: E501 format (str): Expected file format.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out.py new file mode 100644 index 000000000..a5ff946f7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out.py @@ -0,0 +1,296 @@ +""" + 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.json_api_fiscal_calendar_out_attributes import JsonApiFiscalCalendarOutAttributes + globals()['JsonApiFiscalCalendarOutAttributes'] = JsonApiFiscalCalendarOutAttributes + + +class JsonApiFiscalCalendarOut(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',): { + 'FISCALCALENDAR': "fiscalCalendar", + }, + } + + 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 + 'type': (str,), # noqa: E501 + 'attributes': (JsonApiFiscalCalendarOutAttributes,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOut - a model defined in OpenAPI + + Args: + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "fiscalCalendar", must be one of ["fiscalCalendar", ] # 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,) + attributes (JsonApiFiscalCalendarOutAttributes): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "fiscalCalendar") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOut - a model defined in OpenAPI + + Args: + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "fiscalCalendar", must be one of ["fiscalCalendar", ] # 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,) + attributes (JsonApiFiscalCalendarOutAttributes): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "fiscalCalendar") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes.py new file mode 100644 index 000000000..3bd8bf5f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes.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.json_api_fiscal_calendar_out_attributes_definition import JsonApiFiscalCalendarOutAttributesDefinition + from gooddata_api_client.model.json_api_fiscal_calendar_out_attributes_enabled_granularities_inner import JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner + globals()['JsonApiFiscalCalendarOutAttributesDefinition'] = JsonApiFiscalCalendarOutAttributesDefinition + globals()['JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner'] = JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner + + +class JsonApiFiscalCalendarOutAttributes(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 = { + ('description',): { + 'max_length': 10000, + }, + ('title',): { + 'max_length': 255, + }, + } + + @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 { + 'are_relations_valid': (bool,), # noqa: E501 + 'definition': (JsonApiFiscalCalendarOutAttributesDefinition,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'enabled_granularities': ([JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner],), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'definition': 'definition', # noqa: E501 + 'description': 'description', # noqa: E501 + 'enabled_granularities': 'enabledGranularities', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutAttributes - 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,) + are_relations_valid (bool): [optional] # noqa: E501 + definition (JsonApiFiscalCalendarOutAttributesDefinition): [optional] # noqa: E501 + description (str): Calendar description.. [optional] # noqa: E501 + enabled_granularities ([JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner]): Granularities available in the calendar, in drill-down order (finest to coarsest). Granularity title prefixes are localizable.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): Calendar title.. [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 + """JsonApiFiscalCalendarOutAttributes - 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,) + are_relations_valid (bool): [optional] # noqa: E501 + definition (JsonApiFiscalCalendarOutAttributesDefinition): [optional] # noqa: E501 + description (str): Calendar description.. [optional] # noqa: E501 + enabled_granularities ([JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner]): Granularities available in the calendar, in drill-down order (finest to coarsest). Granularity title prefixes are localizable.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): Calendar title.. [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/json_api_fiscal_calendar_out_attributes_definition.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_definition.py new file mode 100644 index 000000000..8fe41e62d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_definition.py @@ -0,0 +1,337 @@ +""" + 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.calendar_table_reference import CalendarTableReference + from gooddata_api_client.model.custom_calendar_definition import CustomCalendarDefinition + from gooddata_api_client.model.fiscal_year_calendar_definition import FiscalYearCalendarDefinition + globals()['CalendarTableReference'] = CalendarTableReference + globals()['CustomCalendarDefinition'] = CustomCalendarDefinition + globals()['FiscalYearCalendarDefinition'] = FiscalYearCalendarDefinition + + +class JsonApiFiscalCalendarOutAttributesDefinition(ModelComposed): + """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 { + 'data_source_tables': ({str: (CalendarTableReference,)},), # noqa: E501 + 'month_offset': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'CustomCalendarDefinition': CustomCalendarDefinition, + 'FiscalYearCalendarDefinition': FiscalYearCalendarDefinition, + 'custom': CustomCalendarDefinition, + 'fiscalYear': FiscalYearCalendarDefinition, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'data_source_tables': 'dataSourceTables', # noqa: E501 + 'month_offset': 'monthOffset', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutAttributesDefinition - 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_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [optional] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutAttributesDefinition - 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_tables ({str: (CalendarTableReference,)}): Custom fiscal calendar table per data source ID.. [optional] # noqa: E501 + month_offset (int): Number of months the fiscal year start is shifted relative to the Gregorian year.. [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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + CustomCalendarDefinition, + FiscalYearCalendarDefinition, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_enabled_granularities_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_enabled_granularities_inner.py new file mode 100644 index 000000000..4ab04e8a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_attributes_enabled_granularities_inner.py @@ -0,0 +1,321 @@ +""" + 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 JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner(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',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", + 'MINUTE': "MINUTE", + 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", + 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", + 'DAY_OF_WEEK': "DAY_OF_WEEK", + 'DAY_OF_MONTH': "DAY_OF_MONTH", + 'DAY_OF_QUARTER': "DAY_OF_QUARTER", + 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", + 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", + 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", + 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", + 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", + 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", + 'FISCAL_YEAR': "FISCAL_YEAR", + }, + } + + validations = { + ('prefix',): { + 'max_length': 255, + }, + } + + @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 + 'prefix': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'granularity': 'granularity', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, granularity, prefix, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner - a model defined in OpenAPI + + Args: + granularity (str): Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. + prefix (str): Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. + + 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.granularity = granularity + self.prefix = prefix + 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, prefix, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner - a model defined in OpenAPI + + Args: + granularity (str): Fiscal granularity available in the calendar. Corresponds to the calcique granularity name. + prefix (str): Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism. + + 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.granularity = granularity + self.prefix = prefix + 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_fiscal_calendar_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_document.py new file mode 100644 index 000000000..67d2b6226 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_document.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.json_api_fiscal_calendar_out import JsonApiFiscalCalendarOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiFiscalCalendarOut'] = JsonApiFiscalCalendarOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiFiscalCalendarOutDocument(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 { + 'data': (JsonApiFiscalCalendarOut,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiFiscalCalendarOut): + + 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,) + links (ObjectLinks): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiFiscalCalendarOut): + + 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,) + links (ObjectLinks): [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.data = data + 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_fiscal_calendar_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py new file mode 100644 index 000000000..ec5eb9695 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py @@ -0,0 +1,290 @@ +""" + 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.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_fiscal_calendar_out_with_links import JsonApiFiscalCalendarOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiFiscalCalendarOutWithLinks'] = JsonApiFiscalCalendarOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiFiscalCalendarOutList(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 = { + ('data',): { + }, + } + + @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 { + 'data': ([JsonApiFiscalCalendarOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutList - a model defined in OpenAPI + + Args: + data ([JsonApiFiscalCalendarOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutList - a model defined in OpenAPI + + Args: + data ([JsonApiFiscalCalendarOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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_fiscal_calendar_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_with_links.py new file mode 100644 index 000000000..d34b9ab8b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_with_links.py @@ -0,0 +1,349 @@ +""" + 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.json_api_fiscal_calendar_out import JsonApiFiscalCalendarOut + from gooddata_api_client.model.json_api_fiscal_calendar_out_attributes import JsonApiFiscalCalendarOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiFiscalCalendarOut'] = JsonApiFiscalCalendarOut + globals()['JsonApiFiscalCalendarOutAttributes'] = JsonApiFiscalCalendarOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiFiscalCalendarOutWithLinks(ModelComposed): + """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',): { + 'FISCALCALENDAR': "fiscalCalendar", + }, + } + + 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 + 'type': (str,), # noqa: E501 + 'attributes': (JsonApiFiscalCalendarOutAttributes,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutWithLinks - a model defined in OpenAPI + + Keyword Args: + id (str): API identifier of an object + type (str): Object type. defaults to "fiscalCalendar", must be one of ["fiscalCalendar", ] # 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,) + attributes (JsonApiFiscalCalendarOutAttributes): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "fiscalCalendar") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiFiscalCalendarOutWithLinks - a model defined in OpenAPI + + Keyword Args: + id (str): API identifier of an object + type (str): Object type. defaults to "fiscalCalendar", must be one of ["fiscalCalendar", ] # 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,) + attributes (JsonApiFiscalCalendarOutAttributes): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "fiscalCalendar") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + JsonApiFiscalCalendarOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py index 2bef1e6a6..47aec8f18 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py @@ -76,6 +76,7 @@ class JsonApiJwkInAttributesContent(ModelComposed): validations = { ('kid',): { 'max_length': 255, + 'min_length': 0, 'regex': { 'pattern': r'^[^.]', # noqa: E501 }, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in.py new file mode 100644 index 000000000..ef3f42a09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in.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.json_api_org_memory_item_in_attributes import JsonApiOrgMemoryItemInAttributes + globals()['JsonApiOrgMemoryItemInAttributes'] = JsonApiOrgMemoryItemInAttributes + + +class JsonApiOrgMemoryItemIn(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',): { + 'ORGMEMORYITEM': "orgMemoryItem", + }, + } + + 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 { + 'attributes': (JsonApiOrgMemoryItemInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemIn - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemIn - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in_attributes.py new file mode 100644 index 000000000..d1ee48c14 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in_attributes.py @@ -0,0 +1,305 @@ +""" + 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 JsonApiOrgMemoryItemInAttributes(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 = { + ('strategy',): { + 'ALWAYS': "ALWAYS", + 'AUTO': "AUTO", + }, + } + + validations = { + ('instruction',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('title',): { + 'max_length': 255, + }, + } + + @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 { + 'instruction': (str,), # noqa: E501 + 'strategy': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'is_disabled': (bool,), # noqa: E501 + 'keywords': ([str],), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'instruction': 'instruction', # noqa: E501 + 'strategy': 'strategy', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'keywords': 'keywords', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, instruction, strategy, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemInAttributes - a model defined in OpenAPI + + Args: + instruction (str): The text that will be injected into the system prompt + strategy (str): Strategy defining when the memory item should be applied + + 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,) + description (str, none_type): [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + title (str, none_type): [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.instruction = instruction + self.strategy = strategy + 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, instruction, strategy, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemInAttributes - a model defined in OpenAPI + + Args: + instruction (str): The text that will be injected into the system prompt + strategy (str): Strategy defining when the memory item should be applied + + 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,) + description (str, none_type): [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + title (str, none_type): [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.instruction = instruction + self.strategy = strategy + 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_org_memory_item_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in_document.py new file mode 100644 index 000000000..718d2e99a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_in_document.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.json_api_org_memory_item_in import JsonApiOrgMemoryItemIn + globals()['JsonApiOrgMemoryItemIn'] = JsonApiOrgMemoryItemIn + + +class JsonApiOrgMemoryItemInDocument(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 { + 'data': (JsonApiOrgMemoryItemIn,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemInDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemIn): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemInDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemIn): + + 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.data = data + 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_org_memory_item_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out.py new file mode 100644 index 000000000..daa829030 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out.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.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_org_memory_item_out_attributes import JsonApiOrgMemoryItemOutAttributes + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiOrgMemoryItemOutAttributes'] = JsonApiOrgMemoryItemOutAttributes + + +class JsonApiOrgMemoryItemOut(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',): { + 'ORGMEMORYITEM': "orgMemoryItem", + }, + } + + 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 { + 'attributes': (JsonApiOrgMemoryItemOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'relationships': (JsonApiDashboardPluginOutRelationships,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOut - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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,) + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOut - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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,) + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_attributes.py new file mode 100644 index 000000000..ae29655e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_attributes.py @@ -0,0 +1,323 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiOrgMemoryItemOutAttributes(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 = { + ('strategy',): { + 'ALWAYS': "ALWAYS", + 'AUTO': "AUTO", + }, + } + + validations = { + ('instruction',): { + '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 + }, + }, + ('title',): { + 'max_length': 255, + }, + } + + @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 { + 'instruction': (str,), # noqa: E501 + 'strategy': (str,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'is_disabled': (bool,), # noqa: E501 + 'keywords': ([str],), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'instruction': 'instruction', # noqa: E501 + 'strategy': 'strategy', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'keywords': 'keywords', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, instruction, strategy, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutAttributes - a model defined in OpenAPI + + Args: + instruction (str): The text that will be injected into the system prompt + strategy (str): Strategy defining when the memory item should be applied + + 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,) + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + title (str, none_type): [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.instruction = instruction + self.strategy = strategy + 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, instruction, strategy, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutAttributes - a model defined in OpenAPI + + Args: + instruction (str): The text that will be injected into the system prompt + strategy (str): Strategy defining when the memory item should be applied + + 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,) + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + title (str, none_type): [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.instruction = instruction + self.strategy = strategy + 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_org_memory_item_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py new file mode 100644 index 000000000..a8c9fb9e7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py @@ -0,0 +1,290 @@ +""" + 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.json_api_org_memory_item_out import JsonApiOrgMemoryItemOut + from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiOrgMemoryItemOut'] = JsonApiOrgMemoryItemOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiOrgMemoryItemOutDocument(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 = { + ('included',): { + }, + } + + @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 { + 'data': (JsonApiOrgMemoryItemOut,), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemOut): + + 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,) + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemOut): + + 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,) + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [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.data = data + 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_org_memory_item_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_list.py new file mode 100644 index 000000000..805a68d64 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_list.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.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_org_memory_item_out_with_links import JsonApiOrgMemoryItemOutWithLinks + from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiOrgMemoryItemOutWithLinks'] = JsonApiOrgMemoryItemOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiOrgMemoryItemOutList(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 = { + ('data',): { + }, + ('included',): { + }, + } + + @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 { + 'data': ([JsonApiOrgMemoryItemOutWithLinks],), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutList - a model defined in OpenAPI + + Args: + data ([JsonApiOrgMemoryItemOutWithLinks]): + + 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,) + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutList - a model defined in OpenAPI + + Args: + data ([JsonApiOrgMemoryItemOutWithLinks]): + + 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,) + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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_org_memory_item_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_with_links.py new file mode 100644 index 000000000..526112da1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_with_links.py @@ -0,0 +1,355 @@ +""" + 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.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_org_memory_item_out import JsonApiOrgMemoryItemOut + from gooddata_api_client.model.json_api_org_memory_item_out_attributes import JsonApiOrgMemoryItemOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiOrgMemoryItemOut'] = JsonApiOrgMemoryItemOut + globals()['JsonApiOrgMemoryItemOutAttributes'] = JsonApiOrgMemoryItemOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiOrgMemoryItemOutWithLinks(ModelComposed): + """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',): { + 'ORGMEMORYITEM': "orgMemoryItem", + }, + } + + 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 { + 'attributes': (JsonApiOrgMemoryItemOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'relationships': (JsonApiDashboardPluginOutRelationships,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'relationships': 'relationships', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiOrgMemoryItemOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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,) + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "orgMemoryItem") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiOrgMemoryItemOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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,) + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "orgMemoryItem") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + JsonApiOrgMemoryItemOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch.py new file mode 100644 index 000000000..37643c7c3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch.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.json_api_org_memory_item_patch_attributes import JsonApiOrgMemoryItemPatchAttributes + globals()['JsonApiOrgMemoryItemPatchAttributes'] = JsonApiOrgMemoryItemPatchAttributes + + +class JsonApiOrgMemoryItemPatch(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',): { + 'ORGMEMORYITEM': "orgMemoryItem", + }, + } + + 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 { + 'attributes': (JsonApiOrgMemoryItemPatchAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiOrgMemoryItemPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "orgMemoryItem", must be one of ["orgMemoryItem", ] # 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', "orgMemoryItem") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch_attributes.py new file mode 100644 index 000000000..272912ba1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch_attributes.py @@ -0,0 +1,297 @@ +""" + 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 JsonApiOrgMemoryItemPatchAttributes(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 = { + ('strategy',): { + 'ALWAYS': "ALWAYS", + 'AUTO': "AUTO", + }, + } + + validations = { + ('description',): { + 'max_length': 10000, + }, + ('instruction',): { + 'max_length': 255, + }, + ('title',): { + 'max_length': 255, + }, + } + + @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 { + 'description': (str, none_type,), # noqa: E501 + 'instruction': (str,), # noqa: E501 + 'is_disabled': (bool,), # noqa: E501 + 'keywords': ([str],), # noqa: E501 + 'strategy': (str,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'instruction': 'instruction', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'keywords': 'keywords', # noqa: E501 + 'strategy': 'strategy', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemPatchAttributes - 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,) + description (str, none_type): [optional] # noqa: E501 + instruction (str): The text that will be injected into the system prompt. [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + strategy (str): Strategy defining when the memory item should be applied. [optional] # noqa: E501 + title (str, none_type): [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 + """JsonApiOrgMemoryItemPatchAttributes - 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,) + description (str, none_type): [optional] # noqa: E501 + instruction (str): The text that will be injected into the system prompt. [optional] # noqa: E501 + is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 + keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 + strategy (str): Strategy defining when the memory item should be applied. [optional] # noqa: E501 + title (str, none_type): [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/json_api_org_memory_item_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch_document.py new file mode 100644 index 000000000..7f1ae06c5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_patch_document.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.json_api_org_memory_item_patch import JsonApiOrgMemoryItemPatch + globals()['JsonApiOrgMemoryItemPatch'] = JsonApiOrgMemoryItemPatch + + +class JsonApiOrgMemoryItemPatchDocument(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 { + 'data': (JsonApiOrgMemoryItemPatch,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemPatch): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiOrgMemoryItemPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiOrgMemoryItemPatch): + + 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.data = data + 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_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py index 0f8ad526a..5621ea851 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 @@ -83,6 +83,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", + 'DEFAULT_EXPORT_TEMPLATE': "DEFAULT_EXPORT_TEMPLATE", 'ENABLE_SNAPSHOT_EXPORT': "ENABLE_SNAPSHOT_EXPORT", 'AI_RATE_LIMIT': "AI_RATE_LIMIT", 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", @@ -103,6 +104,7 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", '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", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py index 8c141c0bd..65744a9e9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_includes.py @@ -37,8 +37,8 @@ def lazy_import(): from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships + from gooddata_api_client.model.json_api_workspace_out_attributes import JsonApiWorkspaceOutAttributes from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks @@ -48,8 +48,8 @@ def lazy_import(): globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships + globals()['JsonApiWorkspaceOutAttributes'] = JsonApiWorkspaceOutAttributes globals()['JsonApiWorkspaceOutMeta'] = JsonApiWorkspaceOutMeta globals()['JsonApiWorkspaceOutWithLinks'] = JsonApiWorkspaceOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -119,7 +119,7 @@ def openapi_types(): 'meta': (JsonApiWorkspaceOutMeta,), # noqa: E501 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 + 'attributes': (JsonApiWorkspaceOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -180,7 +180,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 type (str): Object type. [optional] if omitted the server will use the default value of "workspace" # noqa: E501 """ @@ -289,7 +289,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 type (str): Object type. [optional] if omitted the server will use the default value of "workspace" # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in.py new file mode 100644 index 000000000..93a2d1f09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in.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.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + + +class JsonApiWorkspaceColorPaletteIn(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',): { + 'WORKSPACECOLORPALETTE': "workspaceColorPalette", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteIn - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteIn - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in_document.py new file mode 100644 index 000000000..368446a63 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_in_document.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.json_api_workspace_color_palette_in import JsonApiWorkspaceColorPaletteIn + globals()['JsonApiWorkspaceColorPaletteIn'] = JsonApiWorkspaceColorPaletteIn + + +class JsonApiWorkspaceColorPaletteInDocument(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 { + 'data': (JsonApiWorkspaceColorPaletteIn,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPaletteIn): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPaletteIn): + + 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.data = data + 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_workspace_color_palette_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out.py new file mode 100644 index 000000000..cfc0dca21 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out.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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + + +class JsonApiWorkspaceColorPaletteOut(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',): { + 'WORKSPACECOLORPALETTE': "workspaceColorPalette", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOut - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOut - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_document.py new file mode 100644 index 000000000..b68df40de --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_document.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.json_api_workspace_color_palette_out import JsonApiWorkspaceColorPaletteOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiWorkspaceColorPaletteOut'] = JsonApiWorkspaceColorPaletteOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiWorkspaceColorPaletteOutDocument(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 { + 'data': (JsonApiWorkspaceColorPaletteOut,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPaletteOut): + + 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,) + links (ObjectLinks): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPaletteOut): + + 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,) + links (ObjectLinks): [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.data = data + 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_workspace_color_palette_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py new file mode 100644 index 000000000..472c52e3d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py @@ -0,0 +1,290 @@ +""" + 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.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_workspace_color_palette_out_with_links import JsonApiWorkspaceColorPaletteOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiWorkspaceColorPaletteOutWithLinks'] = JsonApiWorkspaceColorPaletteOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiWorkspaceColorPaletteOutList(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 = { + ('data',): { + }, + } + + @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 { + 'data': ([JsonApiWorkspaceColorPaletteOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceColorPaletteOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceColorPaletteOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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_workspace_color_palette_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_with_links.py new file mode 100644 index 000000000..168162f2a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_with_links.py @@ -0,0 +1,355 @@ +""" + 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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + from gooddata_api_client.model.json_api_workspace_color_palette_out import JsonApiWorkspaceColorPaletteOut + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + globals()['JsonApiWorkspaceColorPaletteOut'] = JsonApiWorkspaceColorPaletteOut + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiWorkspaceColorPaletteOutWithLinks(ModelComposed): + """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',): { + 'WORKSPACECOLORPALETTE': "workspaceColorPalette", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceColorPalette") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPaletteOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceColorPalette") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + JsonApiWorkspaceColorPaletteOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch.py new file mode 100644 index 000000000..f8d70a437 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch.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.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes + globals()['JsonApiColorPalettePatchAttributes'] = JsonApiColorPalettePatchAttributes + + +class JsonApiWorkspaceColorPalettePatch(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',): { + 'WORKSPACECOLORPALETTE': "workspaceColorPalette", + }, + } + + 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 { + 'attributes': (JsonApiColorPalettePatchAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPalettePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPalettePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPalettePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPalettePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceColorPalette", must be one of ["workspaceColorPalette", ] # 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', "workspaceColorPalette") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch_document.py new file mode 100644 index 000000000..01ff294bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_patch_document.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.json_api_workspace_color_palette_patch import JsonApiWorkspaceColorPalettePatch + globals()['JsonApiWorkspaceColorPalettePatch'] = JsonApiWorkspaceColorPalettePatch + + +class JsonApiWorkspaceColorPalettePatchDocument(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 { + 'data': (JsonApiWorkspaceColorPalettePatch,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPalettePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPalettePatch): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceColorPalettePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceColorPalettePatch): + + 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.data = data + 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_workspace_export_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in.py new file mode 100644 index 000000000..39576609d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in.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.json_api_workspace_export_template_in_attributes import JsonApiWorkspaceExportTemplateInAttributes + globals()['JsonApiWorkspaceExportTemplateInAttributes'] = JsonApiWorkspaceExportTemplateInAttributes + + +class JsonApiWorkspaceExportTemplateIn(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',): { + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + }, + } + + 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 { + 'attributes': (JsonApiWorkspaceExportTemplateInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes.py new file mode 100644 index 000000000..c5a7bc2a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes.py @@ -0,0 +1,289 @@ +""" + 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.json_api_workspace_export_template_in_attributes_dashboard_slides_template import JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate + from gooddata_api_client.model.json_api_workspace_export_template_in_attributes_widget_slides_template import JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate + globals()['JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate + globals()['JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate + + +class JsonApiWorkspaceExportTemplateInAttributes(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 = { + ('name',): { + 'max_length': 255, + }, + } + + @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 { + 'name': (str,), # noqa: E501 + 'dashboard_slides_template': (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 + 'widget_slides_template': (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributes - a model defined in OpenAPI + + Args: + name (str): User-facing name of the Slides template. + + 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,) + dashboard_slides_template (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributes - a model defined in OpenAPI + + Args: + name (str): User-facing name of the Slides template. + + 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,) + dashboard_slides_template (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + widget_slides_template (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes_dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes_dashboard_slides_template.py new file mode 100644 index 000000000..43ed3ef1e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes_dashboard_slides_template.py @@ -0,0 +1,305 @@ +""" + 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.content_slide_template import ContentSlideTemplate + from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate + from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate + from gooddata_api_client.model.section_slide_template import SectionSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + globals()['CoverSlideTemplate'] = CoverSlideTemplate + globals()['IntroSlideTemplate'] = IntroSlideTemplate + globals()['SectionSlideTemplate'] = SectionSlideTemplate + + +class JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate(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 = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @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 = True + + @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 { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + 'cover_slide': (CoverSlideTemplate,), # noqa: E501 + 'intro_slide': (IntroSlideTemplate,), # noqa: E501 + 'section_slide': (SectionSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + 'cover_slide': 'coverSlide', # noqa: E501 + 'intro_slide': 'introSlide', # noqa: E501 + 'section_slide': 'sectionSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [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.applied_on = applied_on + 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, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [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.applied_on = applied_on + 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_workspace_export_template_in_attributes_widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes_widget_slides_template.py new file mode 100644 index 000000000..5fb2f5aed --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_attributes_widget_slides_template.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.content_slide_template import ContentSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + + +class JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate(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 = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @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 = True + + @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 { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [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.applied_on = applied_on + 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, applied_on, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [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.applied_on = applied_on + 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_workspace_export_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_document.py new file mode 100644 index 000000000..ad620652c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_in_document.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.json_api_workspace_export_template_in import JsonApiWorkspaceExportTemplateIn + globals()['JsonApiWorkspaceExportTemplateIn'] = JsonApiWorkspaceExportTemplateIn + + +class JsonApiWorkspaceExportTemplateInDocument(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 { + 'data': (JsonApiWorkspaceExportTemplateIn,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplateIn): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplateIn): + + 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.data = data + 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_workspace_export_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out.py new file mode 100644 index 000000000..3bd125edc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out.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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_workspace_export_template_in_attributes import JsonApiWorkspaceExportTemplateInAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiWorkspaceExportTemplateInAttributes'] = JsonApiWorkspaceExportTemplateInAttributes + + +class JsonApiWorkspaceExportTemplateOut(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',): { + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + }, + } + + 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 { + 'attributes': (JsonApiWorkspaceExportTemplateInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_document.py new file mode 100644 index 000000000..4b49acd3b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_document.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.json_api_workspace_export_template_out import JsonApiWorkspaceExportTemplateOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiWorkspaceExportTemplateOut'] = JsonApiWorkspaceExportTemplateOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiWorkspaceExportTemplateOutDocument(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 { + 'data': (JsonApiWorkspaceExportTemplateOut,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplateOut): + + 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,) + links (ObjectLinks): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplateOut): + + 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,) + links (ObjectLinks): [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.data = data + 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_workspace_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py new file mode 100644 index 000000000..a30c65400 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py @@ -0,0 +1,290 @@ +""" + 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.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_workspace_export_template_out_with_links import JsonApiWorkspaceExportTemplateOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiWorkspaceExportTemplateOutWithLinks'] = JsonApiWorkspaceExportTemplateOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiWorkspaceExportTemplateOutList(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 = { + ('data',): { + }, + } + + @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 { + 'data': ([JsonApiWorkspaceExportTemplateOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceExportTemplateOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceExportTemplateOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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_workspace_export_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_with_links.py new file mode 100644 index 000000000..082442447 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_with_links.py @@ -0,0 +1,355 @@ +""" + 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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_workspace_export_template_in_attributes import JsonApiWorkspaceExportTemplateInAttributes + from gooddata_api_client.model.json_api_workspace_export_template_out import JsonApiWorkspaceExportTemplateOut + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiWorkspaceExportTemplateInAttributes'] = JsonApiWorkspaceExportTemplateInAttributes + globals()['JsonApiWorkspaceExportTemplateOut'] = JsonApiWorkspaceExportTemplateOut + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiWorkspaceExportTemplateOutWithLinks(ModelComposed): + """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',): { + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + }, + } + + 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 { + 'attributes': (JsonApiWorkspaceExportTemplateInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + JsonApiWorkspaceExportTemplateOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch.py new file mode 100644 index 000000000..274f87f04 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch.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.json_api_workspace_export_template_patch_attributes import JsonApiWorkspaceExportTemplatePatchAttributes + globals()['JsonApiWorkspaceExportTemplatePatchAttributes'] = JsonApiWorkspaceExportTemplatePatchAttributes + + +class JsonApiWorkspaceExportTemplatePatch(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',): { + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + }, + } + + 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 { + 'attributes': (JsonApiWorkspaceExportTemplatePatchAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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', "workspaceExportTemplate") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch_attributes.py new file mode 100644 index 000000000..29270065d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch_attributes.py @@ -0,0 +1,283 @@ +""" + 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.json_api_workspace_export_template_in_attributes_dashboard_slides_template import JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate + from gooddata_api_client.model.json_api_workspace_export_template_in_attributes_widget_slides_template import JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate + globals()['JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate'] = JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate + globals()['JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate'] = JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate + + +class JsonApiWorkspaceExportTemplatePatchAttributes(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 = { + ('name',): { + 'max_length': 255, + }, + } + + @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 { + 'dashboard_slides_template': (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'widget_slides_template': (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dashboard_slides_template': 'dashboardSlidesTemplate', # noqa: E501 + 'name': 'name', # noqa: E501 + 'widget_slides_template': 'widgetSlidesTemplate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePatchAttributes - 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,) + dashboard_slides_template (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + name (str): User-facing name of the Slides template.. [optional] # noqa: E501 + widget_slides_template (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate): [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 + """JsonApiWorkspaceExportTemplatePatchAttributes - 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,) + dashboard_slides_template (JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate): [optional] # noqa: E501 + name (str): User-facing name of the Slides template.. [optional] # noqa: E501 + widget_slides_template (JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate): [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/json_api_workspace_export_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch_document.py new file mode 100644 index 000000000..68d99095c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_patch_document.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.json_api_workspace_export_template_patch import JsonApiWorkspaceExportTemplatePatch + globals()['JsonApiWorkspaceExportTemplatePatch'] = JsonApiWorkspaceExportTemplatePatch + + +class JsonApiWorkspaceExportTemplatePatchDocument(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 { + 'data': (JsonApiWorkspaceExportTemplatePatch,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplatePatch): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplatePatch): + + 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.data = data + 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_workspace_export_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_post_optional_id.py new file mode 100644 index 000000000..063379af0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_post_optional_id.py @@ -0,0 +1,296 @@ +""" + 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.json_api_workspace_export_template_in_attributes import JsonApiWorkspaceExportTemplateInAttributes + globals()['JsonApiWorkspaceExportTemplateInAttributes'] = JsonApiWorkspaceExportTemplateInAttributes + + +class JsonApiWorkspaceExportTemplatePostOptionalId(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',): { + 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", + }, + } + + 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 { + 'attributes': (JsonApiWorkspaceExportTemplateInAttributes,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + id (str): API identifier of an object. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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.attributes = attributes + 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, attributes, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiWorkspaceExportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "workspaceExportTemplate", must be one of ["workspaceExportTemplate", ] # 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,) + id (str): API identifier of an object. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceExportTemplate") + _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.attributes = attributes + 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_workspace_export_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_post_optional_id_document.py new file mode 100644 index 000000000..fc47396e7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_post_optional_id_document.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.json_api_workspace_export_template_post_optional_id import JsonApiWorkspaceExportTemplatePostOptionalId + globals()['JsonApiWorkspaceExportTemplatePostOptionalId'] = JsonApiWorkspaceExportTemplatePostOptionalId + + +class JsonApiWorkspaceExportTemplatePostOptionalIdDocument(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 { + 'data': (JsonApiWorkspaceExportTemplatePostOptionalId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplatePostOptionalId): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceExportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceExportTemplatePostOptionalId): + + 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.data = data + 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_workspace_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py index 65794d693..caebf944e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships + from gooddata_api_client.model.json_api_workspace_out_attributes import JsonApiWorkspaceOutAttributes from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships + globals()['JsonApiWorkspaceOutAttributes'] = JsonApiWorkspaceOutAttributes globals()['JsonApiWorkspaceOutMeta'] = JsonApiWorkspaceOutMeta @@ -102,7 +102,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 + 'attributes': (JsonApiWorkspaceOutAttributes,), # noqa: E501 'meta': (JsonApiWorkspaceOutMeta,), # noqa: E501 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 } @@ -165,7 +165,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 """ @@ -260,7 +260,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_attributes.py new file mode 100644 index 000000000..364c53456 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_attributes.py @@ -0,0 +1,313 @@ +""" + 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.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource + globals()['JsonApiWorkspaceInAttributesDataSource'] = JsonApiWorkspaceInAttributesDataSource + + +class JsonApiWorkspaceOutAttributes(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 = { + ('description',): { + 'max_length': 255, + }, + ('early_access',): { + 'max_length': 255, + }, + ('name',): { + 'max_length': 255, + }, + ('prefix',): { + 'max_length': 255, + '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 { + 'cache_extra_limit': (int,), # noqa: E501 + 'data_source': (JsonApiWorkspaceInAttributesDataSource,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'early_access': (str, none_type,), # noqa: E501 + 'early_access_values': ([str], none_type,), # noqa: E501 + 'managed': (bool,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'prefix': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'cache_extra_limit': 'cacheExtraLimit', # noqa: E501 + 'data_source': 'dataSource', # noqa: E501 + 'description': 'description', # noqa: E501 + 'early_access': 'earlyAccess', # noqa: E501 + 'early_access_values': 'earlyAccessValues', # noqa: E501 + 'managed': 'managed', # noqa: E501 + 'name': 'name', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceOutAttributes - 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,) + cache_extra_limit (int): [optional] # noqa: E501 + data_source (JsonApiWorkspaceInAttributesDataSource): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 + early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 + managed (bool): Whether the object is platform-managed and read-only.. [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): Custom prefix of entity identifiers in 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__,) + + 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 + """JsonApiWorkspaceOutAttributes - 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,) + cache_extra_limit (int): [optional] # noqa: E501 + data_source (JsonApiWorkspaceInAttributesDataSource): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + early_access (str, none_type): The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.. [optional] # noqa: E501 + early_access_values ([str], none_type): The early access feature identifiers. They are used to enable experimental features.. [optional] # noqa: E501 + managed (bool): Whether the object is platform-managed and read-only.. [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): Custom prefix of entity identifiers in 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__,) + + 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_workspace_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py index 9adfff6af..7ddf5b052 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_with_links.py @@ -31,15 +31,15 @@ def lazy_import(): - from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut + from gooddata_api_client.model.json_api_workspace_out_attributes import JsonApiWorkspaceOutAttributes from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiWorkspaceInAttributes'] = JsonApiWorkspaceInAttributes globals()['JsonApiWorkspaceInRelationships'] = JsonApiWorkspaceInRelationships globals()['JsonApiWorkspaceOut'] = JsonApiWorkspaceOut + globals()['JsonApiWorkspaceOutAttributes'] = JsonApiWorkspaceOutAttributes globals()['JsonApiWorkspaceOutMeta'] = JsonApiWorkspaceOutMeta globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -108,7 +108,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiWorkspaceInAttributes,), # noqa: E501 + 'attributes': (JsonApiWorkspaceOutAttributes,), # noqa: E501 'meta': (JsonApiWorkspaceOutMeta,), # noqa: E501 'relationships': (JsonApiWorkspaceInRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 @@ -169,7 +169,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 @@ -279,7 +279,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiWorkspaceInAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceOutAttributes): [optional] # noqa: E501 meta (JsonApiWorkspaceOutMeta): [optional] # noqa: E501 relationships (JsonApiWorkspaceInRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in.py new file mode 100644 index 000000000..1666f8ad2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in.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.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + + +class JsonApiWorkspaceThemeIn(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',): { + 'WORKSPACETHEME': "workspaceTheme", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeIn - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeIn - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in_document.py new file mode 100644 index 000000000..3356ca223 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_in_document.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.json_api_workspace_theme_in import JsonApiWorkspaceThemeIn + globals()['JsonApiWorkspaceThemeIn'] = JsonApiWorkspaceThemeIn + + +class JsonApiWorkspaceThemeInDocument(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 { + 'data': (JsonApiWorkspaceThemeIn,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemeIn): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeInDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemeIn): + + 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.data = data + 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_workspace_theme_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out.py new file mode 100644 index 000000000..714e897c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out.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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + + +class JsonApiWorkspaceThemeOut(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',): { + 'WORKSPACETHEME': "workspaceTheme", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOut - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOut - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_document.py new file mode 100644 index 000000000..9a4d00338 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_document.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.json_api_workspace_theme_out import JsonApiWorkspaceThemeOut + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiWorkspaceThemeOut'] = JsonApiWorkspaceThemeOut + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiWorkspaceThemeOutDocument(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 { + 'data': (JsonApiWorkspaceThemeOut,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemeOut): + + 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,) + links (ObjectLinks): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemeOut): + + 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,) + links (ObjectLinks): [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.data = data + 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_workspace_theme_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py new file mode 100644 index 000000000..3ae752f37 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py @@ -0,0 +1,290 @@ +""" + 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.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_workspace_theme_out_with_links import JsonApiWorkspaceThemeOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiWorkspaceThemeOutWithLinks'] = JsonApiWorkspaceThemeOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiWorkspaceThemeOutList(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 = { + ('data',): { + }, + } + + @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 { + 'data': ([JsonApiWorkspaceThemeOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceThemeOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutList - a model defined in OpenAPI + + Args: + data ([JsonApiWorkspaceThemeOutWithLinks]): + + 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,) + links (ListLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutListMeta): [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.data = data + 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_workspace_theme_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_with_links.py new file mode 100644 index 000000000..4b3c164e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_with_links.py @@ -0,0 +1,355 @@ +""" + 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.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_color_palette_in_attributes import JsonApiColorPaletteInAttributes + from gooddata_api_client.model.json_api_workspace_theme_out import JsonApiWorkspaceThemeOut + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiColorPaletteInAttributes'] = JsonApiColorPaletteInAttributes + globals()['JsonApiWorkspaceThemeOut'] = JsonApiWorkspaceThemeOut + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiWorkspaceThemeOutWithLinks(ModelComposed): + """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',): { + 'WORKSPACETHEME': "workspaceTheme", + }, + } + + 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 { + 'attributes': (JsonApiColorPaletteInAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceTheme") + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemeOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiColorPaletteInAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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,) + meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "workspaceTheme") + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + JsonApiWorkspaceThemeOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch.py new file mode 100644 index 000000000..d680d7756 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch.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.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes + globals()['JsonApiColorPalettePatchAttributes'] = JsonApiColorPalettePatchAttributes + + +class JsonApiWorkspaceThemePatch(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',): { + 'WORKSPACETHEME': "workspaceTheme", + }, + } + + 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 { + 'attributes': (JsonApiColorPalettePatchAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPalettePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiColorPalettePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "workspaceTheme", must be one of ["workspaceTheme", ] # 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', "workspaceTheme") + _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.attributes = attributes + self.id = id + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch_document.py new file mode 100644 index 000000000..c62bcf69e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_patch_document.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.json_api_workspace_theme_patch import JsonApiWorkspaceThemePatch + globals()['JsonApiWorkspaceThemePatch'] = JsonApiWorkspaceThemePatch + + +class JsonApiWorkspaceThemePatchDocument(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 { + 'data': (JsonApiWorkspaceThemePatch,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemePatch): + + 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.data = data + 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, data, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceThemePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiWorkspaceThemePatch): + + 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.data = data + 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/key_drivers_dimension.py b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py index 9fe93c8c3..d0f6100cf 100644 --- a/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py +++ b/gooddata-api-client/gooddata_api_client/model/key_drivers_dimension.py @@ -63,24 +63,45 @@ class KeyDriversDimension(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, ('value_type',): { diff --git a/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py index c5e8668a1..56d1c7529 100644 --- a/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py +++ b/gooddata-api-client/gooddata_api_client/model/list_llm_provider_models_request.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig - globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig + from gooddata_api_client.model.llm_provider_config import LlmProviderConfig + globals()['LlmProviderConfig'] = LlmProviderConfig class ListLlmProviderModelsRequest(ModelNormal): @@ -88,7 +88,7 @@ def openapi_types(): """ lazy_import() return { - 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 + 'provider_config': (LlmProviderConfig,), # noqa: E501 } @cached_property @@ -111,7 +111,7 @@ def _from_openapi_data(cls, provider_config, *args, **kwargs): # noqa: E501 """ListLlmProviderModelsRequest - a model defined in OpenAPI Args: - provider_config (ListLlmProviderModelsRequestProviderConfig): + provider_config (LlmProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -200,7 +200,7 @@ def __init__(self, provider_config, *args, **kwargs): # noqa: E501 """ListLlmProviderModelsRequest - a model defined in OpenAPI Args: - provider_config (ListLlmProviderModelsRequestProviderConfig): + provider_config (LlmProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/manage_metric_permissions_request_inner.py b/gooddata-api-client/gooddata_api_client/model/manage_metric_permissions_request_inner.py new file mode 100644 index 000000000..6e1ebed06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/manage_metric_permissions_request_inner.py @@ -0,0 +1,340 @@ +""" + 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.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.assignee_rule import AssigneeRule + from gooddata_api_client.model.metric_permissions_for_assignee import MetricPermissionsForAssignee + from gooddata_api_client.model.metric_permissions_for_assignee_rule import MetricPermissionsForAssigneeRule + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AssigneeRule'] = AssigneeRule + globals()['MetricPermissionsForAssignee'] = MetricPermissionsForAssignee + globals()['MetricPermissionsForAssigneeRule'] = MetricPermissionsForAssigneeRule + + +class ManageMetricPermissionsRequestInner(ModelComposed): + """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 = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + 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 { + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ManageMetricPermissionsRequestInner - 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,) + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ManageMetricPermissionsRequestInner - 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,) + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + MetricPermissionsForAssignee, + MetricPermissionsForAssigneeRule, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/measure_item.py b/gooddata-api-client/gooddata_api_client/model/measure_item.py index aa26f1814..c1ff1f149 100644 --- a/gooddata-api-client/gooddata_api_client/model/measure_item.py +++ b/gooddata-api-client/gooddata_api_client/model/measure_item.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.measure_item_definition import MeasureItemDefinition - globals()['MeasureItemDefinition'] = MeasureItemDefinition + from gooddata_api_client.model.measure_definition import MeasureDefinition + globals()['MeasureDefinition'] = MeasureDefinition class MeasureItem(ModelNormal): @@ -93,7 +93,7 @@ def openapi_types(): """ lazy_import() return { - 'definition': (MeasureItemDefinition,), # noqa: E501 + 'definition': (MeasureDefinition,), # noqa: E501 'local_identifier': (str,), # noqa: E501 } @@ -118,7 +118,7 @@ def _from_openapi_data(cls, definition, local_identifier, *args, **kwargs): # n """MeasureItem - a model defined in OpenAPI Args: - definition (MeasureItemDefinition): + definition (MeasureDefinition): local_identifier (str): Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. Keyword Args: @@ -209,7 +209,7 @@ def __init__(self, definition, local_identifier, *args, **kwargs): # noqa: E501 """MeasureItem - a model defined in OpenAPI Args: - definition (MeasureItemDefinition): + definition (MeasureDefinition): local_identifier (str): Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition. Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py b/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py deleted file mode 100644 index b6def417f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/measure_item_definition.py +++ /dev/null @@ -1,354 +0,0 @@ -""" - 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.arithmetic_measure_definition import ArithmeticMeasureDefinition - from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure - from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition - from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline - from gooddata_api_client.model.pop_dataset_measure_definition import PopDatasetMeasureDefinition - from gooddata_api_client.model.pop_dataset_measure_definition_previous_period_measure import PopDatasetMeasureDefinitionPreviousPeriodMeasure - from gooddata_api_client.model.pop_date_measure_definition import PopDateMeasureDefinition - from gooddata_api_client.model.pop_date_measure_definition_over_period_measure import PopDateMeasureDefinitionOverPeriodMeasure - from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition - from gooddata_api_client.model.simple_measure_definition import SimpleMeasureDefinition - from gooddata_api_client.model.simple_measure_definition_measure import SimpleMeasureDefinitionMeasure - globals()['ArithmeticMeasureDefinition'] = ArithmeticMeasureDefinition - globals()['ArithmeticMeasureDefinitionArithmeticMeasure'] = ArithmeticMeasureDefinitionArithmeticMeasure - globals()['InlineMeasureDefinition'] = InlineMeasureDefinition - globals()['InlineMeasureDefinitionInline'] = InlineMeasureDefinitionInline - globals()['PopDatasetMeasureDefinition'] = PopDatasetMeasureDefinition - globals()['PopDatasetMeasureDefinitionPreviousPeriodMeasure'] = PopDatasetMeasureDefinitionPreviousPeriodMeasure - globals()['PopDateMeasureDefinition'] = PopDateMeasureDefinition - globals()['PopDateMeasureDefinitionOverPeriodMeasure'] = PopDateMeasureDefinitionOverPeriodMeasure - globals()['PopMeasureDefinition'] = PopMeasureDefinition - globals()['SimpleMeasureDefinition'] = SimpleMeasureDefinition - globals()['SimpleMeasureDefinitionMeasure'] = SimpleMeasureDefinitionMeasure - - -class MeasureItemDefinition(ModelComposed): - """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 = { - } - - additional_properties_type = None - - _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 { - 'arithmetic_measure': (ArithmeticMeasureDefinitionArithmeticMeasure,), # noqa: E501 - 'inline': (InlineMeasureDefinitionInline,), # noqa: E501 - 'previous_period_measure': (PopDatasetMeasureDefinitionPreviousPeriodMeasure,), # noqa: E501 - 'over_period_measure': (PopDateMeasureDefinitionOverPeriodMeasure,), # noqa: E501 - 'measure': (SimpleMeasureDefinitionMeasure,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'arithmetic_measure': 'arithmeticMeasure', # noqa: E501 - 'inline': 'inline', # noqa: E501 - 'previous_period_measure': 'previousPeriodMeasure', # noqa: E501 - 'over_period_measure': 'overPeriodMeasure', # noqa: E501 - 'measure': 'measure', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """MeasureItemDefinition - 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,) - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [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', ()) - - 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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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', - '_composed_instances', - '_var_name_to_model_instances', - '_additional_properties_model_instances', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """MeasureItemDefinition - 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,) - arithmetic_measure (ArithmeticMeasureDefinitionArithmeticMeasure): [optional] # noqa: E501 - inline (InlineMeasureDefinitionInline): [optional] # noqa: E501 - previous_period_measure (PopDatasetMeasureDefinitionPreviousPeriodMeasure): [optional] # noqa: E501 - over_period_measure (PopDateMeasureDefinitionOverPeriodMeasure): [optional] # noqa: E501 - measure (SimpleMeasureDefinitionMeasure): [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__,) - - constant_args = { - '_check_type': _check_type, - '_path_to_item': _path_to_item, - '_spec_property_naming': _spec_property_naming, - '_configuration': _configuration, - '_visited_composed_classes': self._visited_composed_classes, - } - composed_info = validate_get_composed_info( - constant_args, kwargs, self) - self._composed_instances = composed_info[0] - self._var_name_to_model_instances = composed_info[1] - self._additional_properties_model_instances = composed_info[2] - discarded_args = composed_info[3] - - for var_name, var_value in kwargs.items(): - if var_name in discarded_args and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self._additional_properties_model_instances: - # 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.") - - @cached_property - def _composed_schemas(): - # we need this here to make our import statements work - # we must store _composed_schemas in here so the code is only run - # when we invoke this method. If we kept this at the class - # level we would get an error because the class level - # code would be run when this module is imported, and these composed - # classes don't exist yet because their module has not finished - # loading - lazy_import() - return { - 'anyOf': [ - ], - 'allOf': [ - ], - 'oneOf': [ - ArithmeticMeasureDefinition, - InlineMeasureDefinition, - PopDatasetMeasureDefinition, - PopDateMeasureDefinition, - PopMeasureDefinition, - SimpleMeasureDefinition, - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/metric_permissions.py b/gooddata-api-client/gooddata_api_client/model/metric_permissions.py new file mode 100644 index 000000000..15b56067c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_permissions.py @@ -0,0 +1,292 @@ +""" + 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.rule_permission import RulePermission + from gooddata_api_client.model.user_group_permission import UserGroupPermission + from gooddata_api_client.model.user_permission import UserPermission + globals()['RulePermission'] = RulePermission + globals()['UserGroupPermission'] = UserGroupPermission + globals()['UserPermission'] = UserPermission + + +class MetricPermissions(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 { + 'rules': ([RulePermission],), # noqa: E501 + 'user_groups': ([UserGroupPermission],), # noqa: E501 + 'users': ([UserPermission],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'rules': 'rules', # noqa: E501 + 'user_groups': 'userGroups', # noqa: E501 + 'users': 'users', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """MetricPermissions - a model defined in OpenAPI + + Args: + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users + + 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.rules = rules + self.user_groups = user_groups + self.users = users + 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, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """MetricPermissions - a model defined in OpenAPI + + Args: + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users + + 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.rules = rules + self.user_groups = user_groups + self.users = users + 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/metric_permissions_assignment.py b/gooddata-api-client/gooddata_api_client/model/metric_permissions_assignment.py new file mode 100644 index 000000000..b8ed3143d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_permissions_assignment.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 MetricPermissionsAssignment(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 = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + 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 { + 'permissions': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, permissions, *args, **kwargs): # noqa: E501 + """MetricPermissionsAssignment - a model defined in OpenAPI + + Args: + permissions ([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,) + """ + + _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.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, permissions, *args, **kwargs): # noqa: E501 + """MetricPermissionsAssignment - a model defined in OpenAPI + + Args: + permissions ([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,) + """ + + _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.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/metric_permissions_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/metric_permissions_for_assignee.py new file mode 100644 index 000000000..45802eae4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_permissions_for_assignee.py @@ -0,0 +1,334 @@ +""" + 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.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.ldm_object_permissions_for_assignee_all_of import LdmObjectPermissionsForAssigneeAllOf + from gooddata_api_client.model.metric_permissions_assignment import MetricPermissionsAssignment + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['LdmObjectPermissionsForAssigneeAllOf'] = LdmObjectPermissionsForAssigneeAllOf + globals()['MetricPermissionsAssignment'] = MetricPermissionsAssignment + + +class MetricPermissionsForAssignee(ModelComposed): + """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 = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + 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 { + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MetricPermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MetricPermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + LdmObjectPermissionsForAssigneeAllOf, + MetricPermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/metric_permissions_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/metric_permissions_for_assignee_rule.py new file mode 100644 index 000000000..25cc32d44 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/metric_permissions_for_assignee_rule.py @@ -0,0 +1,334 @@ +""" + 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.assignee_rule import AssigneeRule + from gooddata_api_client.model.declarative_analytical_dashboard_permission_for_assignee_rule_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf + from gooddata_api_client.model.metric_permissions_assignment import MetricPermissionsAssignment + globals()['AssigneeRule'] = AssigneeRule + globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf + globals()['MetricPermissionsAssignment'] = MetricPermissionsAssignment + + +class MetricPermissionsForAssigneeRule(ModelComposed): + """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 = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + 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 { + 'permissions': ([str],), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MetricPermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _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', ()) + + 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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MetricPermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _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__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # 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.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + DeclarativeAnalyticalDashboardPermissionForAssigneeRuleAllOf, + MetricPermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/notes.py b/gooddata-api-client/gooddata_api_client/model/notes.py index 9c91f4f85..e3e7b9e30 100644 --- a/gooddata-api-client/gooddata_api_client/model/notes.py +++ b/gooddata-api-client/gooddata_api_client/model/notes.py @@ -107,9 +107,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, note, *args, **kwargs): # noqa: E501 """Notes - a model defined in OpenAPI + Args: + note ([Note]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -141,7 +144,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - note ([Note]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -173,6 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.note = note for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -193,9 +196,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 + def __init__(self, note, *args, **kwargs): # noqa: E501 """Notes - a model defined in OpenAPI + Args: + note ([Note]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -227,7 +233,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - note ([Note]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -257,6 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.note = note for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/notification_parameter.py b/gooddata-api-client/gooddata_api_client/model/notification_parameter.py new file mode 100644 index 000000000..64a9cafab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/notification_parameter.py @@ -0,0 +1,280 @@ +""" + 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 NotificationParameter(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 { + 'id': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'value': 'value', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, value, *args, **kwargs): # noqa: E501 + """NotificationParameter - a model defined in OpenAPI + + Args: + id (str): + value (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,) + title (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.id = id + self.value = value + 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, value, *args, **kwargs): # noqa: E501 + """NotificationParameter - a model defined in OpenAPI + + Args: + id (str): + value (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,) + title (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.id = id + self.value = value + 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/outlier_detection_request.py b/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.py index 913c0e084..d226c5772 100644 --- a/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.py +++ b/gooddata-api-client/gooddata_api_client/model/outlier_detection_request.py @@ -32,10 +32,10 @@ def lazy_import(): from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner + from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.measure_item import MeasureItem globals()['AttributeItem'] = AttributeItem - globals()['ChangeAnalysisParamsFiltersInner'] = ChangeAnalysisParamsFiltersInner + globals()['FilterDefinition'] = FilterDefinition globals()['MeasureItem'] = MeasureItem @@ -109,11 +109,11 @@ def openapi_types(): lazy_import() return { 'attributes': ([AttributeItem],), # noqa: E501 - 'filters': ([ChangeAnalysisParamsFiltersInner],), # noqa: E501 'granularity': (str,), # noqa: E501 'measures': ([MeasureItem],), # noqa: E501 'sensitivity': (str,), # noqa: E501 'aux_measures': ([MeasureItem],), # noqa: E501 + 'filters': ([FilterDefinition],), # noqa: E501 } @cached_property @@ -123,11 +123,11 @@ def discriminator(): attribute_map = { 'attributes': 'attributes', # noqa: E501 - 'filters': 'filters', # noqa: E501 'granularity': 'granularity', # noqa: E501 'measures': 'measures', # noqa: E501 'sensitivity': 'sensitivity', # noqa: E501 'aux_measures': 'auxMeasures', # noqa: E501 + 'filters': 'filters', # noqa: E501 } read_only_vars = { @@ -137,12 +137,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, filters, granularity, measures, sensitivity, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, attributes, granularity, measures, sensitivity, *args, **kwargs): # noqa: E501 """OutlierDetectionRequest - a model defined in OpenAPI Args: attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([ChangeAnalysisParamsFiltersInner]): Various filter types to filter the execution result. granularity (str): Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR). measures ([MeasureItem]): sensitivity (str): Sensitivity level for outlier detection @@ -179,6 +178,7 @@ def _from_openapi_data(cls, attributes, filters, granularity, measures, sensitiv through its discriminator because we passed in _visited_composed_classes = (Animal,) aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 + filters ([FilterDefinition]): Various filter types to filter the execution result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -211,7 +211,6 @@ def _from_openapi_data(cls, attributes, filters, granularity, measures, sensitiv self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.attributes = attributes - self.filters = filters self.granularity = granularity self.measures = measures self.sensitivity = sensitivity @@ -235,12 +234,11 @@ def _from_openapi_data(cls, attributes, filters, granularity, measures, sensitiv ]) @convert_js_args_to_python_args - def __init__(self, attributes, filters, granularity, measures, sensitivity, *args, **kwargs): # noqa: E501 + def __init__(self, attributes, granularity, measures, sensitivity, *args, **kwargs): # noqa: E501 """OutlierDetectionRequest - a model defined in OpenAPI Args: attributes ([AttributeItem]): Attributes to be used in the computation. - filters ([ChangeAnalysisParamsFiltersInner]): Various filter types to filter the execution result. granularity (str): Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR). measures ([MeasureItem]): sensitivity (str): Sensitivity level for outlier detection @@ -277,6 +275,7 @@ def __init__(self, attributes, filters, granularity, measures, sensitivity, *arg through its discriminator because we passed in _visited_composed_classes = (Animal,) aux_measures ([MeasureItem]): Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.. [optional] # noqa: E501 + filters ([FilterDefinition]): Various filter types to filter the execution result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -307,7 +306,6 @@ def __init__(self, attributes, filters, granularity, measures, sensitivity, *arg self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.attributes = attributes - self.filters = filters self.granularity = granularity self.measures = measures self.sensitivity = sensitivity diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_parameter_value.py b/gooddata-api-client/gooddata_api_client/model/parameter_value.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/dashboard_parameter_value.py rename to gooddata-api-client/gooddata_api_client/model/parameter_value.py index 8010c51a1..65beb630f 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_parameter_value.py +++ b/gooddata-api-client/gooddata_api_client/model/parameter_value.py @@ -31,7 +31,7 @@ -class DashboardParameterValue(ModelNormal): +class ParameterValue(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -106,7 +106,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, id, title, value, *args, **kwargs): # noqa: E501 - """DashboardParameterValue - a model defined in OpenAPI + """ParameterValue - a model defined in OpenAPI Args: id (str): Identifier of the workspace parameter (matches the parameter entity id). @@ -199,7 +199,7 @@ def _from_openapi_data(cls, id, title, value, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, id, title, value, *args, **kwargs): # noqa: E501 - """DashboardParameterValue - a model defined in OpenAPI + """ParameterValue - a model defined in OpenAPI Args: id (str): Identifier of the workspace parameter (matches the parameter entity id). 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 c0013cec1..fe3a5adc9 100644 --- a/gooddata-api-client/gooddata_api_client/model/pending_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/pending_operation.py @@ -60,6 +60,9 @@ class PendingOperation(ModelComposed): """ allowed_values = { + ('status',): { + 'PENDING': "pending", + }, ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", @@ -97,9 +100,9 @@ def openapi_types(): """ lazy_import() return { + 'status': (str,), # noqa: E501 'id': (str,), # noqa: E501 'kind': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 } @cached_property @@ -111,9 +114,9 @@ def discriminator(): return {'status': val} attribute_map = { + 'status': 'status', # noqa: E501 'id': 'id', # noqa: E501 'kind': 'kind', # noqa: E501 - 'status': 'status', # noqa: E501 } read_only_vars = { @@ -125,9 +128,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """PendingOperation - a model defined in OpenAPI 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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,6 +163,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + status = kwargs.get('status', "pending") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -231,9 +235,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 """PendingOperation - a model defined in OpenAPI 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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. @@ -266,6 +270,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + status = kwargs.get('status', "pending") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) diff --git a/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py b/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py index 1e7eae843..9365a7deb 100644 --- a/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/permissions_assignment.py @@ -67,6 +67,9 @@ class PermissionsAssignment(ModelNormal): } validations = { + ('assignees',): { + 'min_items': 1, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table.py b/gooddata-api-client/gooddata_api_client/model/pipe_table.py index b6af30709..819cff394 100644 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table.py +++ b/gooddata-api-client/gooddata_api_client/model/pipe_table.py @@ -32,13 +32,13 @@ def lazy_import(): from gooddata_api_client.model.column_info import ColumnInfo - from gooddata_api_client.model.pipe_table_distribution_config import PipeTableDistributionConfig - from gooddata_api_client.model.pipe_table_key_config import PipeTableKeyConfig - from gooddata_api_client.model.pipe_table_partition_config import PipeTablePartitionConfig + from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig + from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig + from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig globals()['ColumnInfo'] = ColumnInfo - globals()['PipeTableDistributionConfig'] = PipeTableDistributionConfig - globals()['PipeTableKeyConfig'] = PipeTableKeyConfig - globals()['PipeTablePartitionConfig'] = PipeTablePartitionConfig + globals()['CreatePipeTableRequestDistributionConfig'] = CreatePipeTableRequestDistributionConfig + globals()['CreatePipeTableRequestKeyConfig'] = CreatePipeTableRequestKeyConfig + globals()['CreatePipeTableRequestPartitionConfig'] = CreatePipeTableRequestPartitionConfig class PipeTable(ModelNormal): @@ -96,8 +96,8 @@ def openapi_types(): return { 'columns': ([ColumnInfo],), # noqa: E501 'database_name': (str,), # noqa: E501 - 'distribution_config': (PipeTableDistributionConfig,), # noqa: E501 - 'key_config': (PipeTableKeyConfig,), # noqa: E501 + 'distribution_config': (CreatePipeTableRequestDistributionConfig,), # noqa: E501 + 'key_config': (CreatePipeTableRequestKeyConfig,), # noqa: E501 'partition_columns': ([str],), # noqa: E501 'path_prefix': (str,), # noqa: E501 'pipe_table_id': (str,), # noqa: E501 @@ -105,7 +105,7 @@ def openapi_types(): 'source_storage_name': (str,), # noqa: E501 'table_name': (str,), # noqa: E501 'table_properties': ({str: (str,)},), # noqa: E501 - 'partition_config': (PipeTablePartitionConfig,), # noqa: E501 + 'partition_config': (CreatePipeTableRequestPartitionConfig,), # noqa: E501 } @cached_property @@ -141,8 +141,8 @@ def _from_openapi_data(cls, columns, database_name, distribution_config, key_con Args: columns ([ColumnInfo]): Inferred column schema database_name (str): Database name - distribution_config (PipeTableDistributionConfig): - key_config (PipeTableKeyConfig): + distribution_config (CreatePipeTableRequestDistributionConfig): + key_config (CreatePipeTableRequestKeyConfig): partition_columns ([str]): Hive partition columns detected from the path structure path_prefix (str): Path prefix to the parquet files pipe_table_id (str): Internal UUID of the pipe table record @@ -182,7 +182,7 @@ def _from_openapi_data(cls, columns, database_name, distribution_config, key_con Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - partition_config (PipeTablePartitionConfig): [optional] # noqa: E501 + partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -251,8 +251,8 @@ def __init__(self, columns, database_name, distribution_config, key_config, part Args: columns ([ColumnInfo]): Inferred column schema database_name (str): Database name - distribution_config (PipeTableDistributionConfig): - key_config (PipeTableKeyConfig): + distribution_config (CreatePipeTableRequestDistributionConfig): + key_config (CreatePipeTableRequestKeyConfig): partition_columns ([str]): Hive partition columns detected from the path structure path_prefix (str): Path prefix to the parquet files pipe_table_id (str): Internal UUID of the pipe table record @@ -292,7 +292,7 @@ def __init__(self, columns, database_name, distribution_config, key_config, part Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - partition_config (PipeTablePartitionConfig): [optional] # noqa: E501 + partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/primary_key_config.py b/gooddata-api-client/gooddata_api_client/model/primary_key_config.py index 62f9cba89..eaeed54e9 100644 --- a/gooddata-api-client/gooddata_api_client/model/primary_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/primary_key_config.py @@ -56,6 +56,9 @@ class PrimaryKeyConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'PRIMARY': "primary", + }, } validations = { @@ -82,6 +85,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'columns': ([str],), # noqa: E501 } @@ -91,6 +95,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'columns': 'columns', # noqa: E501 } @@ -104,7 +109,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """PrimaryKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "primary", must be one of ["primary", ] # 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. @@ -138,6 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "primary") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -167,6 +176,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -190,7 +200,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """PrimaryKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "primary", must be one of ["primary", ] # 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. @@ -224,6 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "primary") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -251,6 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py index b130c00f3..318a2f6f9 100644 --- a/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py @@ -56,6 +56,9 @@ class RandomDistributionConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'RANDOM': "random", + }, } validations = { @@ -85,6 +88,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'buckets': (int,), # noqa: E501 } @@ -94,6 +98,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'buckets': 'buckets', # noqa: E501 } @@ -107,7 +112,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """RandomDistributionConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "random", must be one of ["random", ] # 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. @@ -141,6 +149,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 """ + type = kwargs.get('type', "random") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -170,6 +179,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -193,7 +203,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """RandomDistributionConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "random", must be one of ["random", ] # 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. @@ -227,6 +240,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 """ + type = kwargs.get('type', "random") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -254,6 +268,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ 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 9eafebfdb..d4a7f942c 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 @@ -80,9 +80,30 @@ class RelativeBoundedDateFilter(ModelNormal): 'GDC.TIME.HOUR_IN_DAY': "GDC.time.hour_in_day", 'GDC.TIME.MINUTE': "GDC.time.minute", 'GDC.TIME.MINUTE_IN_HOUR': "GDC.time.minute_in_hour", + 'GDC.TIME.MINUTE_IN_DAY': "GDC.time.minute_in_day", + 'GDC.TIME.SECOND': "GDC.time.second", + 'GDC.TIME.SECOND_IN_MINUTE': "GDC.time.second_in_minute", + 'GDC.TIME.SECOND_IN_DAY': "GDC.time.second_in_day", + 'GDC.TIME.FISCAL_WEEK': "GDC.time.fiscal_week", 'GDC.TIME.FISCAL_MONTH': "GDC.time.fiscal_month", 'GDC.TIME.FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'GDC.TIME.FISCAL_SEMESTER': "GDC.time.fiscal_semester", 'GDC.TIME.FISCAL_YEAR': "GDC.time.fiscal_year", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_WEEK': "GDC.time.fiscal_day_in_fiscal_week", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_MONTH': "GDC.time.fiscal_day_in_fiscal_month", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_QUARTER': "GDC.time.fiscal_day_in_fiscal_quarter", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_SEMESTER': "GDC.time.fiscal_day_in_fiscal_semester", + 'GDC.TIME.FISCAL_DAY_IN_FISCAL_YEAR': "GDC.time.fiscal_day_in_fiscal_year", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_MONTH': "GDC.time.fiscal_week_in_fiscal_month", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_QUARTER': "GDC.time.fiscal_week_in_fiscal_quarter", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_SEMESTER': "GDC.time.fiscal_week_in_fiscal_semester", + 'GDC.TIME.FISCAL_WEEK_IN_FISCAL_YEAR': "GDC.time.fiscal_week_in_fiscal_year", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_QUARTER': "GDC.time.fiscal_month_in_fiscal_quarter", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_SEMESTER': "GDC.time.fiscal_month_in_fiscal_semester", + 'GDC.TIME.FISCAL_MONTH_IN_FISCAL_YEAR': "GDC.time.fiscal_month_in_fiscal_year", + 'GDC.TIME.FISCAL_QUARTER_IN_FISCAL_SEMESTER': "GDC.time.fiscal_quarter_in_fiscal_semester", + 'GDC.TIME.FISCAL_QUARTER_IN_FISCAL_YEAR': "GDC.time.fiscal_quarter_in_fiscal_year", + 'GDC.TIME.FISCAL_SEMESTER_IN_FISCAL_YEAR': "GDC.time.fiscal_semester_in_fiscal_year", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py index 821f386e6..929bd3991 100644 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py @@ -63,24 +63,45 @@ class RelativeDateFilterRelativeDateFilter(ModelNormal): allowed_values = { ('granularity',): { + 'SECOND': "SECOND", + 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", + 'SECOND_OF_DAY': "SECOND_OF_DAY", 'MINUTE': "MINUTE", - 'HOUR': "HOUR", - 'DAY': "DAY", - 'WEEK': "WEEK", - 'MONTH': "MONTH", - 'QUARTER': "QUARTER", - 'YEAR': "YEAR", 'MINUTE_OF_HOUR': "MINUTE_OF_HOUR", + 'MINUTE_OF_DAY': "MINUTE_OF_DAY", + 'HOUR': "HOUR", 'HOUR_OF_DAY': "HOUR_OF_DAY", + 'DAY': "DAY", 'DAY_OF_WEEK': "DAY_OF_WEEK", 'DAY_OF_MONTH': "DAY_OF_MONTH", 'DAY_OF_QUARTER': "DAY_OF_QUARTER", 'DAY_OF_YEAR': "DAY_OF_YEAR", + 'WEEK': "WEEK", 'WEEK_OF_YEAR': "WEEK_OF_YEAR", + 'MONTH': "MONTH", 'MONTH_OF_YEAR': "MONTH_OF_YEAR", + 'QUARTER': "QUARTER", 'QUARTER_OF_YEAR': "QUARTER_OF_YEAR", + 'YEAR': "YEAR", + 'FISCAL_DAY_OF_FISCAL_WEEK': "FISCAL_DAY_OF_FISCAL_WEEK", + 'FISCAL_DAY_OF_FISCAL_MONTH': "FISCAL_DAY_OF_FISCAL_MONTH", + 'FISCAL_DAY_OF_FISCAL_QUARTER': "FISCAL_DAY_OF_FISCAL_QUARTER", + 'FISCAL_DAY_OF_FISCAL_SEMESTER': "FISCAL_DAY_OF_FISCAL_SEMESTER", + 'FISCAL_DAY_OF_FISCAL_YEAR': "FISCAL_DAY_OF_FISCAL_YEAR", + 'FISCAL_WEEK': "FISCAL_WEEK", + 'FISCAL_WEEK_OF_FISCAL_MONTH': "FISCAL_WEEK_OF_FISCAL_MONTH", + 'FISCAL_WEEK_OF_FISCAL_QUARTER': "FISCAL_WEEK_OF_FISCAL_QUARTER", + 'FISCAL_WEEK_OF_FISCAL_SEMESTER': "FISCAL_WEEK_OF_FISCAL_SEMESTER", + 'FISCAL_WEEK_OF_FISCAL_YEAR': "FISCAL_WEEK_OF_FISCAL_YEAR", 'FISCAL_MONTH': "FISCAL_MONTH", + 'FISCAL_MONTH_OF_FISCAL_QUARTER': "FISCAL_MONTH_OF_FISCAL_QUARTER", + 'FISCAL_MONTH_OF_FISCAL_SEMESTER': "FISCAL_MONTH_OF_FISCAL_SEMESTER", + 'FISCAL_MONTH_OF_FISCAL_YEAR': "FISCAL_MONTH_OF_FISCAL_YEAR", 'FISCAL_QUARTER': "FISCAL_QUARTER", + 'FISCAL_QUARTER_OF_FISCAL_SEMESTER': "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + 'FISCAL_QUARTER_OF_FISCAL_YEAR': "FISCAL_QUARTER_OF_FISCAL_YEAR", + 'FISCAL_SEMESTER': "FISCAL_SEMESTER", + 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, ('empty_value_handling',): { 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 3cc1785ed..6173e0ad2 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -87,6 +87,7 @@ class ResolvedSetting(ModelNormal): 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", + 'DEFAULT_EXPORT_TEMPLATE': "DEFAULT_EXPORT_TEMPLATE", 'ENABLE_SNAPSHOT_EXPORT': "ENABLE_SNAPSHOT_EXPORT", 'AI_RATE_LIMIT': "AI_RATE_LIMIT", 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", @@ -107,6 +108,7 @@ class ResolvedSetting(ModelNormal): 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", '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", 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", diff --git a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py index a9f49e10a..d1d33f792 100644 --- a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py @@ -60,6 +60,9 @@ class RichTextWidgetDescriptor(ModelNormal): """ allowed_values = { + ('widget_type',): { + 'RICHTEXT': "richText", + }, } validations = { @@ -90,6 +93,7 @@ def openapi_types(): return { 'title': (str,), # noqa: E501 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 'content': (str,), # noqa: E501 'filters': ([FilterDefinition],), # noqa: E501 } @@ -102,6 +106,7 @@ def discriminator(): attribute_map = { 'title': 'title', # noqa: E501 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 'content': 'content', # noqa: E501 'filters': 'filters', # noqa: E501 } @@ -121,6 +126,7 @@ def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "richText", must be one of ["richText", ] # 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. @@ -155,6 +161,7 @@ def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "richText") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -186,6 +193,7 @@ def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 self.title = title self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -214,6 +222,7 @@ def __init__(self, title, widget_id, *args, **kwargs): # noqa: E501 widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "richText", must be one of ["richText", ] # 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. @@ -248,6 +257,7 @@ def __init__(self, title, widget_id, *args, **kwargs): # noqa: E501 filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "richText") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -277,6 +287,7 @@ def __init__(self, title, widget_id, *args, **kwargs): # noqa: E501 self.title = title self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py index e34913213..e6283d481 100644 --- a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py +++ b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py @@ -72,6 +72,7 @@ class RsaSpecification(ModelNormal): validations = { ('kid',): { 'max_length': 255, + 'min_length': 0, 'regex': { 'pattern': r'^[^.]', # noqa: E501 }, diff --git a/gooddata-api-client/gooddata_api_client/model/schedule_cache_retention.py b/gooddata-api-client/gooddata_api_client/model/schedule_cache_retention.py new file mode 100644 index 000000000..e94655fe1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/schedule_cache_retention.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.cache_retention_schedule import CacheRetentionSchedule + globals()['CacheRetentionSchedule'] = CacheRetentionSchedule + + +class ScheduleCacheRetention(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',): { + 'SCHEDULE': "SCHEDULE", + }, + } + + 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 { + 'schedule': (CacheRetentionSchedule,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'schedule': 'schedule', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, schedule, *args, **kwargs): # noqa: E501 + """ScheduleCacheRetention - a model defined in OpenAPI + + Args: + schedule (CacheRetentionSchedule): + + Keyword Args: + type (str): The cache retention type.. defaults to "SCHEDULE", must be one of ["SCHEDULE", ] # 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', "SCHEDULE") + _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.schedule = schedule + 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, schedule, *args, **kwargs): # noqa: E501 + """ScheduleCacheRetention - a model defined in OpenAPI + + Args: + schedule (CacheRetentionSchedule): + + Keyword Args: + type (str): The cache retention type.. defaults to "SCHEDULE", must be one of ["SCHEDULE", ] # 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', "SCHEDULE") + _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.schedule = schedule + 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/search_result_object.py b/gooddata-api-client/gooddata_api_client/model/search_result_object.py index 49425a56e..1e68b9545 100644 --- a/gooddata-api-client/gooddata_api_client/model/search_result_object.py +++ b/gooddata-api-client/gooddata_api_client/model/search_result_object.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.certification_info import CertificationInfo + globals()['CertificationInfo'] = CertificationInfo + class SearchResultObject(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -69,6 +73,7 @@ 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 @@ -83,11 +88,13 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 'type': (str,), # noqa: E501 'workspace_id': (str,), # noqa: E501 + 'certification': (CertificationInfo,), # noqa: E501 'created_at': (datetime,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -110,6 +117,7 @@ def discriminator(): 'title': 'title', # noqa: E501 'type': 'type', # noqa: E501 'workspace_id': 'workspaceId', # noqa: E501 + 'certification': 'certification', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -169,6 +177,7 @@ def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + certification (CertificationInfo): [optional] # noqa: E501 created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 description (str): Object description.. [optional] # noqa: E501 is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 @@ -274,6 +283,7 @@ def __init__(self, id, title, type, workspace_id, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + certification (CertificationInfo): [optional] # noqa: E501 created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 description (str): Object description.. [optional] # noqa: E501 is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/slides_export_request.py b/gooddata-api-client/gooddata_api_client/model/slides_export_request.py index fb5d9037b..be308b5d4 100644 --- a/gooddata-api-client/gooddata_api_client/model/slides_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/slides_export_request.py @@ -106,6 +106,7 @@ def openapi_types(): 'dashboard_id': (str,), # noqa: E501 'metadata': (JsonNode,), # noqa: E501 'template_id': (str, none_type,), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 'visualization_ids': ([str],), # noqa: E501 'widget_ids': ([str],), # noqa: E501 } @@ -121,6 +122,7 @@ def discriminator(): 'dashboard_id': 'dashboardId', # noqa: E501 'metadata': 'metadata', # noqa: E501 'template_id': 'templateId', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 'visualization_ids': 'visualizationIds', # noqa: E501 'widget_ids': 'widgetIds', # noqa: E501 } @@ -173,6 +175,7 @@ def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ @@ -269,6 +272,7 @@ def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 dashboard_id (str): Dashboard identifier. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 template_id (str, none_type): Export template identifier.. [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 visualization_ids ([str]): List of visualization ids to be exported. Note that only one visualization is currently supported.. [optional] # noqa: E501 widget_ids ([str]): List of widget identifiers to be exported. Note that only one widget is currently supported.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/string_constraints.py b/gooddata-api-client/gooddata_api_client/model/string_constraints.py index 2226847e1..400c55a6d 100644 --- a/gooddata-api-client/gooddata_api_client/model/string_constraints.py +++ b/gooddata-api-client/gooddata_api_client/model/string_constraints.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.string_parameter_allowed_value import StringParameterAllowedValue + globals()['StringParameterAllowedValue'] = StringParameterAllowedValue + class StringConstraints(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -59,6 +63,8 @@ class StringConstraints(ModelNormal): } validations = { + ('allowed_values',): { + }, } @cached_property @@ -67,6 +73,7 @@ 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 @@ -81,7 +88,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { + 'allowed_values': ([StringParameterAllowedValue],), # noqa: E501 'max_length': (int,), # noqa: E501 'min_length': (int,), # noqa: E501 } @@ -92,6 +101,7 @@ def discriminator(): attribute_map = { + 'allowed_values': 'allowedValues', # noqa: E501 'max_length': 'maxLength', # noqa: E501 'min_length': 'minLength', # noqa: E501 } @@ -137,6 +147,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + allowed_values ([StringParameterAllowedValue]): [optional] # noqa: E501 max_length (int): [optional] # noqa: E501 min_length (int): [optional] # noqa: E501 """ @@ -224,6 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + allowed_values ([StringParameterAllowedValue]): [optional] # noqa: E501 max_length (int): [optional] # noqa: E501 min_length (int): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py b/gooddata-api-client/gooddata_api_client/model/string_parameter_allowed_value.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py rename to gooddata-api-client/gooddata_api_client/model/string_parameter_allowed_value.py index a25d2c414..6f1fb3ff8 100644 --- a/gooddata-api-client/gooddata_api_client/model/llm_provider_auth.py +++ b/gooddata-api-client/gooddata_api_client/model/string_parameter_allowed_value.py @@ -31,7 +31,7 @@ -class LlmProviderAuth(ModelNormal): +class StringParameterAllowedValue(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -82,7 +82,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'type': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 } @cached_property @@ -91,7 +92,8 @@ def discriminator(): attribute_map = { - 'type': 'type', # noqa: E501 + 'value': 'value', # noqa: E501 + 'title': 'title', # noqa: E501 } read_only_vars = { @@ -101,11 +103,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """LlmProviderAuth - a model defined in OpenAPI + def _from_openapi_data(cls, value, *args, **kwargs): # noqa: E501 + """StringParameterAllowedValue - a model defined in OpenAPI Args: - type (str): + value (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -138,6 +140,7 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -169,7 +172,7 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type + self.value = value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -190,11 +193,11 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """LlmProviderAuth - a model defined in OpenAPI + def __init__(self, value, *args, **kwargs): # noqa: E501 + """StringParameterAllowedValue - a model defined in OpenAPI Args: - type (str): + value (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -227,6 +230,7 @@ def __init__(self, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + title (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -256,7 +260,7 @@ def __init__(self, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type + self.value = value for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py index a80c2e57a..a4446394c 100644 --- a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py @@ -62,6 +62,9 @@ class SucceededOperation(ModelComposed): """ allowed_values = { + ('status',): { + 'SUCCEEDED': "succeeded", + }, ('kind',): { 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", @@ -99,9 +102,9 @@ def openapi_types(): """ lazy_import() return { + 'status': (str,), # noqa: E501 'id': (str,), # noqa: E501 'kind': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 'result': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 } @@ -114,9 +117,9 @@ def discriminator(): return {'status': val} attribute_map = { + 'status': 'status', # noqa: E501 'id': 'id', # noqa: E501 'kind': 'kind', # noqa: E501 - 'status': 'status', # noqa: E501 'result': 'result', # noqa: E501 } @@ -129,9 +132,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """SucceededOperation - a model defined in OpenAPI 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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. @@ -165,6 +168,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 """ + status = kwargs.get('status', "succeeded") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -236,9 +240,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 """SucceededOperation - a model defined in OpenAPI 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. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). - status (str): _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. @@ -272,6 +276,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 """ + status = kwargs.get('status', "succeeded") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) diff --git a/gooddata-api-client/gooddata_api_client/model/tabular_export_execution.py b/gooddata-api-client/gooddata_api_client/model/tabular_export_execution.py new file mode 100644 index 000000000..6a5d8f86a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/tabular_export_execution.py @@ -0,0 +1,284 @@ +""" + 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.custom_override import CustomOverride + globals()['CustomOverride'] = CustomOverride + + +class TabularExportExecution(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 { + 'execution_result': (str,), # noqa: E501 + 'custom_override': (CustomOverride,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'execution_result': 'executionResult', # noqa: E501 + 'custom_override': 'customOverride', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, execution_result, *args, **kwargs): # noqa: E501 + """TabularExportExecution - a model defined in OpenAPI + + Args: + execution_result (str): Execution result identifier for this layer. + + 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,) + custom_override (CustomOverride): [optional] # noqa: E501 + title (str): Layer title used for the exported sheet or file name.. [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.execution_result = execution_result + 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, execution_result, *args, **kwargs): # noqa: E501 + """TabularExportExecution - a model defined in OpenAPI + + Args: + execution_result (str): Execution result identifier for this layer. + + 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,) + custom_override (CustomOverride): [optional] # noqa: E501 + title (str): Layer title used for the exported sheet or file name.. [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.execution_result = execution_result + 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/tabular_export_request.py b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py index a9e41b998..92735cd43 100644 --- a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py @@ -32,11 +32,17 @@ def lazy_import(): from gooddata_api_client.model.custom_override import CustomOverride + from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode + from gooddata_api_client.model.parameter_value import ParameterValue from gooddata_api_client.model.settings import Settings + from gooddata_api_client.model.tabular_export_execution import TabularExportExecution globals()['CustomOverride'] = CustomOverride + globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode + globals()['ParameterValue'] = ParameterValue globals()['Settings'] = Settings + globals()['TabularExportExecution'] = TabularExportExecution class TabularExportRequest(ModelNormal): @@ -102,11 +108,14 @@ def openapi_types(): 'format': (str,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 + 'execution_settings': (ExecutionSettings,), # noqa: E501 + 'executions': ([TabularExportExecution],), # noqa: E501 'metadata': (JsonNode,), # noqa: E501 'related_dashboard_id': (str,), # noqa: E501 'settings': (Settings,), # noqa: E501 'visualization_object': (str,), # noqa: E501 'visualization_object_custom_filters': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 + 'visualization_object_custom_parameters': ([ParameterValue],), # noqa: E501 } @cached_property @@ -119,11 +128,14 @@ def discriminator(): 'format': 'format', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 + 'execution_settings': 'executionSettings', # noqa: E501 + 'executions': 'executions', # noqa: E501 'metadata': 'metadata', # noqa: E501 'related_dashboard_id': 'relatedDashboardId', # noqa: E501 'settings': 'settings', # noqa: E501 'visualization_object': 'visualizationObject', # noqa: E501 'visualization_object_custom_filters': 'visualizationObjectCustomFilters', # noqa: E501 + 'visualization_object_custom_parameters': 'visualizationObjectCustomParameters', # noqa: E501 } read_only_vars = { @@ -173,11 +185,14 @@ def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -271,11 +286,14 @@ def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 + execution_settings (ExecutionSettings): [optional] # noqa: E501 + executions ([TabularExportExecution]): Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 related_dashboard_id (str): Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.. [optional] # noqa: E501 settings (Settings): [optional] # noqa: E501 visualization_object (str): Visualization object identifier. Alternative to executionResult property.. [optional] # noqa: E501 visualization_object_custom_filters ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.. [optional] # noqa: E501 + visualization_object_custom_parameters ([ParameterValue]): Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/test_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_definition_request.py index 9fa8b4497..fa1a3b969 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_definition_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_definition_request.py @@ -90,6 +90,14 @@ class TestDefinitionRequest(ModelNormal): 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", }, + ('authentication_type',): { + 'None': None, + 'USERNAME_PASSWORD': "USERNAME_PASSWORD", + 'TOKEN': "TOKEN", + 'KEY_PAIR': "KEY_PAIR", + 'CLIENT_SECRET': "CLIENT_SECRET", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", + }, } validations = { @@ -119,6 +127,7 @@ def openapi_types(): lazy_import() return { 'type': (str,), # noqa: E501 + 'authentication_type': (str, none_type,), # noqa: E501 'client_id': (str,), # noqa: E501 'client_secret': (str,), # noqa: E501 'parameters': ([DataSourceParameter],), # noqa: E501 @@ -138,6 +147,7 @@ def discriminator(): attribute_map = { 'type': 'type', # noqa: E501 + 'authentication_type': 'authenticationType', # noqa: E501 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 'parameters': 'parameters', # noqa: E501 @@ -194,6 +204,7 @@ def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + authentication_type (str, none_type): Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).. [optional] # noqa: E501 client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 parameters ([DataSourceParameter]): [optional] # noqa: E501 @@ -293,6 +304,7 @@ def __init__(self, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + authentication_type (str, none_type): Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).. [optional] # noqa: E501 client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 parameters ([DataSourceParameter]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/test_destination_request.py b/gooddata-api-client/gooddata_api_client/model/test_destination_request.py index 965eb81d5..71b66c152 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_destination_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_destination_request.py @@ -32,9 +32,9 @@ def lazy_import(): from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient - from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination + from gooddata_api_client.model.notification_channel_destination import NotificationChannelDestination globals()['AutomationExternalRecipient'] = AutomationExternalRecipient - globals()['DeclarativeNotificationChannelDestination'] = DeclarativeNotificationChannelDestination + globals()['NotificationChannelDestination'] = NotificationChannelDestination class TestDestinationRequest(ModelNormal): @@ -93,7 +93,7 @@ def openapi_types(): """ lazy_import() return { - 'destination': (DeclarativeNotificationChannelDestination,), # noqa: E501 + 'destination': (NotificationChannelDestination,), # noqa: E501 'external_recipients': ([AutomationExternalRecipient], none_type,), # noqa: E501 } @@ -118,7 +118,7 @@ def _from_openapi_data(cls, destination, *args, **kwargs): # noqa: E501 """TestDestinationRequest - a model defined in OpenAPI Args: - destination (DeclarativeNotificationChannelDestination): + destination (NotificationChannelDestination): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -208,7 +208,7 @@ def __init__(self, destination, *args, **kwargs): # noqa: E501 """TestDestinationRequest - a model defined in OpenAPI Args: - destination (DeclarativeNotificationChannelDestination): + destination (NotificationChannelDestination): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py index 1cd1a741f..0f51e553d 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_by_id_request.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig from gooddata_api_client.model.llm_model import LlmModel - globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig + from gooddata_api_client.model.llm_provider_config import LlmProviderConfig globals()['LlmModel'] = LlmModel + globals()['LlmProviderConfig'] = LlmProviderConfig class TestLlmProviderByIdRequest(ModelNormal): @@ -91,7 +91,7 @@ def openapi_types(): lazy_import() return { 'models': ([LlmModel],), # noqa: E501 - 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 + 'provider_config': (LlmProviderConfig,), # noqa: E501 } @cached_property @@ -146,7 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) models ([LlmModel]): Models overrides.. [optional] # noqa: E501 - provider_config (ListLlmProviderModelsRequestProviderConfig): [optional] # noqa: E501 + provider_config (LlmProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -233,7 +233,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) models ([LlmModel]): Models overrides.. [optional] # noqa: E501 - provider_config (ListLlmProviderModelsRequestProviderConfig): [optional] # noqa: E501 + provider_config (LlmProviderConfig): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py index 72ffbb70c..b17d93530 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_llm_provider_definition_request.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig from gooddata_api_client.model.llm_model import LlmModel - globals()['ListLlmProviderModelsRequestProviderConfig'] = ListLlmProviderModelsRequestProviderConfig + from gooddata_api_client.model.llm_provider_config import LlmProviderConfig globals()['LlmModel'] = LlmModel + globals()['LlmProviderConfig'] = LlmProviderConfig class TestLlmProviderDefinitionRequest(ModelNormal): @@ -90,7 +90,7 @@ def openapi_types(): """ lazy_import() return { - 'provider_config': (ListLlmProviderModelsRequestProviderConfig,), # noqa: E501 + 'provider_config': (LlmProviderConfig,), # noqa: E501 'models': ([LlmModel],), # noqa: E501 } @@ -115,7 +115,7 @@ def _from_openapi_data(cls, provider_config, *args, **kwargs): # noqa: E501 """TestLlmProviderDefinitionRequest - a model defined in OpenAPI Args: - provider_config (ListLlmProviderModelsRequestProviderConfig): + provider_config (LlmProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -205,7 +205,7 @@ def __init__(self, provider_config, *args, **kwargs): # noqa: E501 """TestLlmProviderDefinitionRequest - a model defined in OpenAPI Args: - provider_config (ListLlmProviderModelsRequestProviderConfig): + provider_config (LlmProviderConfig): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/test_notification.py b/gooddata-api-client/gooddata_api_client/model/test_notification.py index c4155c21a..01392c210 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_notification.py +++ b/gooddata-api-client/gooddata_api_client/model/test_notification.py @@ -62,6 +62,9 @@ class TestNotification(ModelComposed): """ allowed_values = { + ('type',): { + 'TEST': "TEST", + }, } validations = { @@ -90,8 +93,8 @@ def openapi_types(): """ lazy_import() return { - 'message': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 } @cached_property @@ -103,8 +106,8 @@ def discriminator(): return {'type': val} attribute_map = { - 'message': 'message', # noqa: E501 'type': 'type', # noqa: E501 + 'message': 'message', # noqa: E501 } read_only_vars = { @@ -116,8 +119,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """TestNotification - a model defined in OpenAPI Keyword Args: + type (str): defaults to "TEST", must be one of ["TEST", ] # noqa: E501 message (str): - type (str): _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. @@ -150,6 +153,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "TEST") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -221,8 +225,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 """TestNotification - a model defined in OpenAPI Keyword Args: + type (str): defaults to "TEST", must be one of ["TEST", ] # noqa: E501 message (str): - type (str): _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. @@ -255,6 +259,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "TEST") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) diff --git a/gooddata-api-client/gooddata_api_client/model/test_request.py b/gooddata-api-client/gooddata_api_client/model/test_request.py index e253b31e1..48758d244 100644 --- a/gooddata-api-client/gooddata_api_client/model/test_request.py +++ b/gooddata-api-client/gooddata_api_client/model/test_request.py @@ -60,6 +60,14 @@ class TestRequest(ModelNormal): """ allowed_values = { + ('authentication_type',): { + 'None': None, + 'USERNAME_PASSWORD': "USERNAME_PASSWORD", + 'TOKEN': "TOKEN", + 'KEY_PAIR': "KEY_PAIR", + 'CLIENT_SECRET': "CLIENT_SECRET", + 'OIDC_PASSTHROUGH': "OIDC_PASSTHROUGH", + }, } validations = { @@ -88,6 +96,7 @@ def openapi_types(): """ lazy_import() return { + 'authentication_type': (str, none_type,), # noqa: E501 'client_id': (str,), # noqa: E501 'client_secret': (str,), # noqa: E501 'parameters': ([DataSourceParameter],), # noqa: E501 @@ -106,6 +115,7 @@ def discriminator(): attribute_map = { + 'authentication_type': 'authenticationType', # noqa: E501 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 'parameters': 'parameters', # noqa: E501 @@ -159,6 +169,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + authentication_type (str, none_type): Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).. [optional] # noqa: E501 client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 parameters ([DataSourceParameter]): [optional] # noqa: E501 @@ -254,6 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + authentication_type (str, none_type): Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).. [optional] # noqa: E501 client_id (str): Id for client based authentication for data sources which supports it.. [optional] # noqa: E501 client_secret (str): Secret for client based authentication for data sources which supports it.. [optional] # noqa: E501 parameters ([DataSourceParameter]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py b/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py index 5f3b52aa6..7a960ff69 100644 --- a/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py @@ -56,6 +56,9 @@ class TimeSlicePartitionConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'TIMESLICE': "timeSlice", + }, ('unit',): { 'YEAR': "year", 'QUARTER': "quarter", @@ -99,6 +102,7 @@ def openapi_types(): return { 'column': (str,), # noqa: E501 'slices': (int,), # noqa: E501 + 'type': (str,), # noqa: E501 'unit': (str,), # noqa: E501 } @@ -110,6 +114,7 @@ def discriminator(): attribute_map = { 'column': 'column', # noqa: E501 'slices': 'slices', # noqa: E501 + 'type': 'type', # noqa: E501 'unit': 'unit', # noqa: E501 } @@ -129,6 +134,7 @@ def _from_openapi_data(cls, column, slices, unit, *args, **kwargs): # noqa: E50 unit (str): Date/time unit for partition granularity Keyword Args: + type (str): defaults to "timeSlice", must be one of ["timeSlice", ] # 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. @@ -161,6 +167,7 @@ def _from_openapi_data(cls, column, slices, unit, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "timeSlice") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -192,6 +199,7 @@ def _from_openapi_data(cls, column, slices, unit, *args, **kwargs): # noqa: E50 self.column = column self.slices = slices + self.type = type self.unit = unit for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -222,6 +230,7 @@ def __init__(self, column, slices, unit, *args, **kwargs): # noqa: E501 unit (str): Date/time unit for partition granularity Keyword Args: + type (str): defaults to "timeSlice", must be one of ["timeSlice", ] # 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. @@ -254,6 +263,7 @@ def __init__(self, column, slices, unit, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "timeSlice") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -283,6 +293,7 @@ def __init__(self, column, slices, unit, *args, **kwargs): # noqa: E501 self.column = column self.slices = slices + self.type = type self.unit = unit for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/unique_key_config.py b/gooddata-api-client/gooddata_api_client/model/unique_key_config.py index b11edaeb5..60a315fd5 100644 --- a/gooddata-api-client/gooddata_api_client/model/unique_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/unique_key_config.py @@ -56,6 +56,9 @@ class UniqueKeyConfig(ModelNormal): """ allowed_values = { + ('type',): { + 'UNIQUE': "unique", + }, } validations = { @@ -82,6 +85,7 @@ def openapi_types(): and the value is attribute type. """ return { + 'type': (str,), # noqa: E501 'columns': ([str],), # noqa: E501 } @@ -91,6 +95,7 @@ def discriminator(): attribute_map = { + 'type': 'type', # noqa: E501 'columns': 'columns', # noqa: E501 } @@ -104,7 +109,10 @@ def discriminator(): def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 """UniqueKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "unique", must be one of ["unique", ] # 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. @@ -138,6 +146,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "unique") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -167,6 +176,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 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 \ @@ -190,7 +200,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 def __init__(self, *args, **kwargs): # noqa: E501 """UniqueKeyConfig - a model defined in OpenAPI + Args: + Keyword Args: + type (str): defaults to "unique", must be one of ["unique", ] # 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. @@ -224,6 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 """ + type = kwargs.get('type', "unique") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -251,6 +265,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py index b1e5dcda9..f1a09024e 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/user_management_data_source_permission_assignment.py @@ -60,6 +60,10 @@ class UserManagementDataSourcePermissionAssignment(ModelNormal): 'MANAGE': "MANAGE", 'USE': "USE", }, + ('access_source',): { + 'DIRECT': "DIRECT", + 'GROUP': "GROUP", + }, } validations = { @@ -88,6 +92,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'permissions': ([str],), # noqa: E501 + 'access_source': (str,), # noqa: E501 'name': (str,), # noqa: E501 } @@ -99,10 +104,12 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'permissions': 'permissions', # noqa: E501 + 'access_source': 'accessSource', # noqa: E501 'name': 'name', # noqa: E501 } read_only_vars = { + 'access_source', # noqa: E501 'name', # noqa: E501 } @@ -148,6 +155,7 @@ def _from_openapi_data(cls, id, permissions, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + access_source (str): How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.. [optional] # noqa: E501 name (str): Name of the datasource. [optional] # noqa: E501 """ @@ -240,6 +248,7 @@ def __init__(self, id, permissions, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + access_source (str): How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.. [optional] # noqa: E501 name (str): Name of the datasource. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py index ca54223c6..16ce82697 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py @@ -82,6 +82,11 @@ class UserManagementWorkspacePermissionAssignment(ModelNormal): 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'VIEW': "VIEW", }, + ('access_source',): { + 'DIRECT': "DIRECT", + 'GROUP': "GROUP", + 'HIERARCHY': "HIERARCHY", + }, } validations = { @@ -111,6 +116,7 @@ def openapi_types(): 'hierarchy_permissions': ([str],), # noqa: E501 'id': (str,), # noqa: E501 'permissions': ([str],), # noqa: E501 + 'access_source': (str,), # noqa: E501 'name': (str,), # noqa: E501 } @@ -123,10 +129,12 @@ def discriminator(): 'hierarchy_permissions': 'hierarchyPermissions', # noqa: E501 'id': 'id', # noqa: E501 'permissions': 'permissions', # noqa: E501 + 'access_source': 'accessSource', # noqa: E501 'name': 'name', # noqa: E501 } read_only_vars = { + 'access_source', # noqa: E501 'name', # noqa: E501 } @@ -173,6 +181,7 @@ def _from_openapi_data(cls, hierarchy_permissions, id, permissions, *args, **kwa Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + access_source (str): How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.. [optional] # noqa: E501 name (str): [optional] # noqa: E501 """ @@ -267,6 +276,7 @@ def __init__(self, hierarchy_permissions, id, permissions, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + access_source (str): How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.. [optional] # noqa: E501 name (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/validity_period_cache_retention.py b/gooddata-api-client/gooddata_api_client/model/validity_period_cache_retention.py new file mode 100644 index 000000000..ff69f3752 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/validity_period_cache_retention.py @@ -0,0 +1,281 @@ +""" + 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 ValidityPeriodCacheRetention(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',): { + 'VALIDITY_PERIOD': "VALIDITY_PERIOD", + }, + } + + 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 + 'validity_period': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'validity_period': 'validityPeriod', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, validity_period, *args, **kwargs): # noqa: E501 + """ValidityPeriodCacheRetention - a model defined in OpenAPI + + Args: + validity_period (str): How long the cached results stay valid after they were computed. + + Keyword Args: + type (str): The cache retention type.. defaults to "VALIDITY_PERIOD", must be one of ["VALIDITY_PERIOD", ] # 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', "VALIDITY_PERIOD") + _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 + self.validity_period = validity_period + 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, validity_period, *args, **kwargs): # noqa: E501 + """ValidityPeriodCacheRetention - a model defined in OpenAPI + + Args: + validity_period (str): How long the cached results stay valid after they were computed. + + Keyword Args: + type (str): The cache retention type.. defaults to "VALIDITY_PERIOD", must be one of ["VALIDITY_PERIOD", ] # 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', "VALIDITY_PERIOD") + _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 + self.validity_period = validity_period + 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/visual_export_request.py b/gooddata-api-client/gooddata_api_client/model/visual_export_request.py index 6b756431d..05fd4e8f3 100644 --- a/gooddata-api-client/gooddata_api_client/model/visual_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/visual_export_request.py @@ -85,6 +85,7 @@ def openapi_types(): 'dashboard_id': (str,), # noqa: E501 'file_name': (str,), # noqa: E501 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 } @cached_property @@ -96,6 +97,7 @@ def discriminator(): 'dashboard_id': 'dashboardId', # noqa: E501 'file_name': 'fileName', # noqa: E501 'metadata': 'metadata', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 } read_only_vars = { @@ -144,6 +146,7 @@ def _from_openapi_data(cls, dashboard_id, file_name, *args, **kwargs): # noqa: through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -236,6 +239,7 @@ def __init__(self, dashboard_id, file_name, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Metadata definition in free-form JSON format.. [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py index e129ab942..359a5b10f 100644 --- a/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py @@ -60,6 +60,9 @@ class VisualizationSwitcherWidgetDescriptor(ModelNormal): """ allowed_values = { + ('widget_type',): { + 'VISUALIZATIONSWITCHER': "visualizationSwitcher", + }, } validations = { @@ -92,6 +95,7 @@ def openapi_types(): 'title': (str,), # noqa: E501 'visualization_ids': ([str],), # noqa: E501 'widget_id': (str,), # noqa: E501 + 'widget_type': (str,), # noqa: E501 'filters': ([FilterDefinition],), # noqa: E501 'result_id': (str,), # noqa: E501 } @@ -106,6 +110,7 @@ def discriminator(): 'title': 'title', # noqa: E501 'visualization_ids': 'visualizationIds', # noqa: E501 'widget_id': 'widgetId', # noqa: E501 + 'widget_type': 'widgetType', # noqa: E501 'filters': 'filters', # noqa: E501 'result_id': 'resultId', # noqa: E501 } @@ -127,6 +132,7 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "visualizationSwitcher", must be one of ["visualizationSwitcher", ] # 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. @@ -161,6 +167,7 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "visualizationSwitcher") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -194,6 +201,7 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w self.title = title self.visualization_ids = visualization_ids self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -224,6 +232,7 @@ def __init__(self, active_visualization_id, title, visualization_ids, widget_id, widget_id (str): Widget object ID. Keyword Args: + widget_type (str): defaults to "visualizationSwitcher", must be one of ["visualizationSwitcher", ] # 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. @@ -258,6 +267,7 @@ def __init__(self, active_visualization_id, title, visualization_ids, widget_id, result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 """ + widget_type = kwargs.get('widget_type', "visualizationSwitcher") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -289,6 +299,7 @@ def __init__(self, active_visualization_id, title, visualization_ids, widget_id, self.title = title self.visualization_ids = visualization_ids self.widget_id = widget_id + self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py b/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py index c6d5e21a0..be88f826c 100644 --- a/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py +++ b/gooddata-api-client/gooddata_api_client/model/webhook_message_data.py @@ -34,11 +34,13 @@ def lazy_import(): from gooddata_api_client.model.alert_description import AlertDescription from gooddata_api_client.model.export_result import ExportResult from gooddata_api_client.model.notification_filter import NotificationFilter + from gooddata_api_client.model.notification_parameter import NotificationParameter from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo from gooddata_api_client.model.webhook_recipient import WebhookRecipient globals()['AlertDescription'] = AlertDescription globals()['ExportResult'] = ExportResult globals()['NotificationFilter'] = NotificationFilter + globals()['NotificationParameter'] = NotificationParameter globals()['WebhookAutomationInfo'] = WebhookAutomationInfo globals()['WebhookRecipient'] = WebhookRecipient @@ -103,6 +105,7 @@ def openapi_types(): 'filters': ([NotificationFilter],), # noqa: E501 'image_exports': ([ExportResult],), # noqa: E501 'notification_source': (str,), # noqa: E501 + 'parameters': ([NotificationParameter],), # noqa: E501 'raw_exports': ([ExportResult],), # noqa: E501 'recipients': ([WebhookRecipient],), # noqa: E501 'remaining_action_count': (int,), # noqa: E501 @@ -124,6 +127,7 @@ def discriminator(): 'filters': 'filters', # noqa: E501 'image_exports': 'imageExports', # noqa: E501 'notification_source': 'notificationSource', # noqa: E501 + 'parameters': 'parameters', # noqa: E501 'raw_exports': 'rawExports', # noqa: E501 'recipients': 'recipients', # noqa: E501 'remaining_action_count': 'remainingActionCount', # noqa: E501 @@ -182,6 +186,7 @@ def _from_openapi_data(cls, automation, *args, **kwargs): # noqa: E501 filters ([NotificationFilter]): [optional] # noqa: E501 image_exports ([ExportResult]): [optional] # noqa: E501 notification_source (str): [optional] # noqa: E501 + parameters ([NotificationParameter]): [optional] # noqa: E501 raw_exports ([ExportResult]): [optional] # noqa: E501 recipients ([WebhookRecipient]): [optional] # noqa: E501 remaining_action_count (int): [optional] # noqa: E501 @@ -283,6 +288,7 @@ def __init__(self, automation, *args, **kwargs): # noqa: E501 filters ([NotificationFilter]): [optional] # noqa: E501 image_exports ([ExportResult]): [optional] # noqa: E501 notification_source (str): [optional] # noqa: E501 + parameters ([NotificationParameter]): [optional] # noqa: E501 raw_exports ([ExportResult]): [optional] # noqa: E501 recipients ([WebhookRecipient]): [optional] # noqa: E501 remaining_action_count (int): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py index 083c8048e..fa4f3dbfc 100644 --- a/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner - globals()['ChangeAnalysisParamsFiltersInner'] = ChangeAnalysisParamsFiltersInner + from gooddata_api_client.model.filter_definition import FilterDefinition + globals()['FilterDefinition'] = FilterDefinition class WidgetDescriptor(ModelNormal): @@ -91,7 +91,7 @@ def openapi_types(): 'title': (str,), # noqa: E501 'widget_id': (str,), # noqa: E501 'widget_type': (str,), # noqa: E501 - 'filters': ([ChangeAnalysisParamsFiltersInner],), # noqa: E501 + 'filters': ([FilterDefinition],), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([ChangeAnalysisParamsFiltersInner]): [optional] # noqa: E501 + filters ([FilterDefinition]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -249,7 +249,7 @@ def __init__(self, title, widget_id, widget_type, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([ChangeAnalysisParamsFiltersInner]): [optional] # noqa: E501 + filters ([FilterDefinition]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_dashboard_slides_template.py b/gooddata-api-client/gooddata_api_client/model/workspace_dashboard_slides_template.py new file mode 100644 index 000000000..8c05c25ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_dashboard_slides_template.py @@ -0,0 +1,305 @@ +""" + 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.content_slide_template import ContentSlideTemplate + from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate + from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate + from gooddata_api_client.model.section_slide_template import SectionSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + globals()['CoverSlideTemplate'] = CoverSlideTemplate + globals()['IntroSlideTemplate'] = IntroSlideTemplate + globals()['SectionSlideTemplate'] = SectionSlideTemplate + + +class WorkspaceDashboardSlidesTemplate(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 = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @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 = True + + @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 { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + 'cover_slide': (CoverSlideTemplate,), # noqa: E501 + 'intro_slide': (IntroSlideTemplate,), # noqa: E501 + 'section_slide': (SectionSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + 'cover_slide': 'coverSlide', # noqa: E501 + 'intro_slide': 'introSlide', # noqa: E501 + 'section_slide': 'sectionSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """WorkspaceDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [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.applied_on = applied_on + 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, applied_on, *args, **kwargs): # noqa: E501 + """WorkspaceDashboardSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [optional] # noqa: E501 + cover_slide (CoverSlideTemplate): [optional] # noqa: E501 + intro_slide (IntroSlideTemplate): [optional] # noqa: E501 + section_slide (SectionSlideTemplate): [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.applied_on = applied_on + 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/workspace_widget_slides_template.py b/gooddata-api-client/gooddata_api_client/model/workspace_widget_slides_template.py new file mode 100644 index 000000000..e34e36abc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_widget_slides_template.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.content_slide_template import ContentSlideTemplate + globals()['ContentSlideTemplate'] = ContentSlideTemplate + + +class WorkspaceWidgetSlidesTemplate(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 = { + ('applied_on',): { + 'PDF': "PDF", + 'PPTX': "PPTX", + }, + } + + validations = { + ('applied_on',): { + 'min_items': 1, + }, + } + + @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 = True + + @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 { + 'applied_on': ([str],), # noqa: E501 + 'content_slide': (ContentSlideTemplate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'applied_on': 'appliedOn', # noqa: E501 + 'content_slide': 'contentSlide', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, applied_on, *args, **kwargs): # noqa: E501 + """WorkspaceWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [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.applied_on = applied_on + 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, applied_on, *args, **kwargs): # noqa: E501 + """WorkspaceWidgetSlidesTemplate - a model defined in OpenAPI + + Args: + applied_on ([str]): Export types this template applies 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,) + content_slide (ContentSlideTemplate): [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.applied_on = applied_on + 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/xliff.py b/gooddata-api-client/gooddata_api_client/model/xliff.py index 206e6ec6f..ab6600299 100644 --- a/gooddata-api-client/gooddata_api_client/model/xliff.py +++ b/gooddata-api-client/gooddata_api_client/model/xliff.py @@ -117,9 +117,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, file, *args, **kwargs): # noqa: E501 """Xliff - a model defined in OpenAPI + Args: + file ([File]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -151,7 +154,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - file ([File]): [optional] # noqa: E501 other_attributes ({str: (str,)}): [optional] # noqa: E501 space (str): [optional] # noqa: E501 src_lang (str): [optional] # noqa: E501 @@ -188,6 +190,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.file = file for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -208,9 +211,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 + def __init__(self, file, *args, **kwargs): # noqa: E501 """Xliff - a model defined in OpenAPI + Args: + file ([File]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -242,7 +248,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - file ([File]): [optional] # noqa: E501 other_attributes ({str: (str,)}): [optional] # noqa: E501 space (str): [optional] # noqa: E501 src_lang (str): [optional] # noqa: E501 @@ -277,6 +282,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.file = file for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index 518bf7ece..254b4f398 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -10,9 +10,10 @@ # sys.setrecursionlimit(n) from gooddata_api_client.model.afm import AFM -from gooddata_api_client.model.afm_filters_inner import AFMFiltersInner from gooddata_api_client.model.absolute_date_filter import AbsoluteDateFilter from gooddata_api_client.model.absolute_date_filter_absolute_date_filter import AbsoluteDateFilterAbsoluteDateFilter +from gooddata_api_client.model.absolute_granularity_date_filter import AbsoluteGranularityDateFilter +from gooddata_api_client.model.absolute_granularity_date_filter_absolute_granularity_date_filter import AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation @@ -93,7 +94,6 @@ from gooddata_api_client.model.attribute_positive_filter_all_of import AttributePositiveFilterAllOf from gooddata_api_client.model.attribute_result_header import AttributeResultHeader from gooddata_api_client.model.automation_alert import AutomationAlert -from gooddata_api_client.model.automation_alert_condition import AutomationAlertCondition from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport from gooddata_api_client.model.automation_external_recipient import AutomationExternalRecipient from gooddata_api_client.model.automation_image_export import AutomationImageExport @@ -116,9 +116,14 @@ from gooddata_api_client.model.bedrock_provider_auth import BedrockProviderAuth from gooddata_api_client.model.bounded_filter import BoundedFilter from gooddata_api_client.model.cache_removal_interval import CacheRemovalInterval +from gooddata_api_client.model.cache_retention import CacheRetention +from gooddata_api_client.model.cache_retention_schedule import CacheRetentionSchedule from gooddata_api_client.model.cache_usage_data import CacheUsageData +from gooddata_api_client.model.calendar_definition import CalendarDefinition +from gooddata_api_client.model.calendar_granularity import CalendarGranularity +from gooddata_api_client.model.calendar_table_reference import CalendarTableReference +from gooddata_api_client.model.certification_info import CertificationInfo from gooddata_api_client.model.change_analysis_params import ChangeAnalysisParams -from gooddata_api_client.model.change_analysis_params_filters_inner import ChangeAnalysisParamsFiltersInner from gooddata_api_client.model.change_analysis_request import ChangeAnalysisRequest from gooddata_api_client.model.change_analysis_response import ChangeAnalysisResponse from gooddata_api_client.model.change_analysis_result import ChangeAnalysisResult @@ -156,6 +161,9 @@ from gooddata_api_client.model.convert_geo_file_response import ConvertGeoFileResponse from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest +from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig +from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig +from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig from gooddata_api_client.model.created_visualization import CreatedVisualization from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner from gooddata_api_client.model.created_visualizations import CreatedVisualizations @@ -164,6 +172,8 @@ from gooddata_api_client.model.csv_manifest_body import CsvManifestBody from gooddata_api_client.model.csv_parse_options import CsvParseOptions from gooddata_api_client.model.csv_read_options import CsvReadOptions +from gooddata_api_client.model.custom_calendar_definition import CustomCalendarDefinition +from gooddata_api_client.model.custom_calendar_definition_all_of import CustomCalendarDefinitionAllOf from gooddata_api_client.model.custom_label import CustomLabel from gooddata_api_client.model.custom_metric import CustomMetric from gooddata_api_client.model.custom_override import CustomOverride @@ -186,7 +196,6 @@ from gooddata_api_client.model.dashboard_match_attribute_filter_match_attribute_filter import DashboardMatchAttributeFilterMatchAttributeFilter from gooddata_api_client.model.dashboard_measure_value_filter import DashboardMeasureValueFilter from gooddata_api_client.model.dashboard_measure_value_filter_dashboard_measure_value_filter import DashboardMeasureValueFilterDashboardMeasureValueFilter -from gooddata_api_client.model.dashboard_parameter_value import DashboardParameterValue from gooddata_api_client.model.dashboard_permissions import DashboardPermissions from gooddata_api_client.model.dashboard_permissions_assignment import DashboardPermissionsAssignment from gooddata_api_client.model.dashboard_slides_template import DashboardSlidesTemplate @@ -229,6 +238,7 @@ from gooddata_api_client.model.declarative_attribute import DeclarativeAttribute from gooddata_api_client.model.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy from gooddata_api_client.model.declarative_automation import DeclarativeAutomation +from gooddata_api_client.model.declarative_calendar import DeclarativeCalendar from gooddata_api_client.model.declarative_color_palette import DeclarativeColorPalette from gooddata_api_client.model.declarative_column import DeclarativeColumn from gooddata_api_client.model.declarative_csp_directive import DeclarativeCspDirective @@ -246,7 +256,6 @@ from gooddata_api_client.model.declarative_date_dataset import DeclarativeDateDataset from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition from gooddata_api_client.model.declarative_export_definition_identifier import DeclarativeExportDefinitionIdentifier -from gooddata_api_client.model.declarative_export_definition_request_payload import DeclarativeExportDefinitionRequestPayload from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates from gooddata_api_client.model.declarative_fact import DeclarativeFact @@ -264,14 +273,12 @@ from gooddata_api_client.model.declarative_metric import DeclarativeMetric from gooddata_api_client.model.declarative_model import DeclarativeModel from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel -from gooddata_api_client.model.declarative_notification_channel_destination import DeclarativeNotificationChannelDestination from gooddata_api_client.model.declarative_notification_channel_identifier import DeclarativeNotificationChannelIdentifier from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels from gooddata_api_client.model.declarative_organization import DeclarativeOrganization from gooddata_api_client.model.declarative_organization_info import DeclarativeOrganizationInfo from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission from gooddata_api_client.model.declarative_parameter import DeclarativeParameter -from gooddata_api_client.model.declarative_parameter_content import DeclarativeParameterContent from gooddata_api_client.model.declarative_reference import DeclarativeReference from gooddata_api_client.model.declarative_reference_source import DeclarativeReferenceSource from gooddata_api_client.model.declarative_rsa_specification import DeclarativeRsaSpecification @@ -296,14 +303,17 @@ 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_workspace import DeclarativeWorkspace +from gooddata_api_client.model.declarative_workspace_color_palette import DeclarativeWorkspaceColorPalette from gooddata_api_client.model.declarative_workspace_data_filter import DeclarativeWorkspaceDataFilter from gooddata_api_client.model.declarative_workspace_data_filter_column import DeclarativeWorkspaceDataFilterColumn from gooddata_api_client.model.declarative_workspace_data_filter_references import DeclarativeWorkspaceDataFilterReferences from gooddata_api_client.model.declarative_workspace_data_filter_setting import DeclarativeWorkspaceDataFilterSetting from gooddata_api_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters +from gooddata_api_client.model.declarative_workspace_export_template import DeclarativeWorkspaceExportTemplate from gooddata_api_client.model.declarative_workspace_hierarchy_permission import DeclarativeWorkspaceHierarchyPermission from gooddata_api_client.model.declarative_workspace_model import DeclarativeWorkspaceModel from gooddata_api_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions +from gooddata_api_client.model.declarative_workspace_theme import DeclarativeWorkspaceTheme from gooddata_api_client.model.declarative_workspaces import DeclarativeWorkspaces from gooddata_api_client.model.default_smtp import DefaultSmtp from gooddata_api_client.model.default_smtp_all_of import DefaultSmtpAllOf @@ -356,6 +366,8 @@ from gooddata_api_client.model.filter_by import FilterBy from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure +from gooddata_api_client.model.fiscal_year_calendar_definition import FiscalYearCalendarDefinition +from gooddata_api_client.model.fiscal_year_calendar_definition_all_of import FiscalYearCalendarDefinitionAllOf from gooddata_api_client.model.forecast_config import ForecastConfig from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult @@ -364,6 +376,8 @@ from gooddata_api_client.model.frequency_bucket import FrequencyBucket from gooddata_api_client.model.frequency_properties import FrequencyProperties from gooddata_api_client.model.gd_storage_file import GdStorageFile +from gooddata_api_client.model.gen_ai_ranking_filter import GenAiRankingFilter +from gooddata_api_client.model.gen_ai_ranking_filter_all_of import GenAiRankingFilterAllOf from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest @@ -400,6 +414,7 @@ from gooddata_api_client.model.import_geo_collection_response import ImportGeoCollectionResponse from gooddata_api_client.model.in_platform import InPlatform from gooddata_api_client.model.in_platform_all_of import InPlatformAllOf +from gooddata_api_client.model.indefinite_cache_retention import IndefiniteCacheRetention from gooddata_api_client.model.inline_filter_definition import InlineFilterDefinition from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition @@ -621,6 +636,7 @@ from gooddata_api_client.model.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks from gooddata_api_client.model.json_api_data_source_in import JsonApiDataSourceIn from gooddata_api_client.model.json_api_data_source_in_attributes import JsonApiDataSourceInAttributes +from gooddata_api_client.model.json_api_data_source_in_attributes_cache_retention import JsonApiDataSourceInAttributesCacheRetention from gooddata_api_client.model.json_api_data_source_in_attributes_parameters_inner import JsonApiDataSourceInAttributesParametersInner from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument from gooddata_api_client.model.json_api_data_source_out import JsonApiDataSourceOut @@ -731,6 +747,13 @@ from gooddata_api_client.model.json_api_filter_view_patch import JsonApiFilterViewPatch from gooddata_api_client.model.json_api_filter_view_patch_attributes import JsonApiFilterViewPatchAttributes from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out import JsonApiFiscalCalendarOut +from gooddata_api_client.model.json_api_fiscal_calendar_out_attributes import JsonApiFiscalCalendarOutAttributes +from gooddata_api_client.model.json_api_fiscal_calendar_out_attributes_definition import JsonApiFiscalCalendarOutAttributesDefinition +from gooddata_api_client.model.json_api_fiscal_calendar_out_attributes_enabled_granularities_inner import JsonApiFiscalCalendarOutAttributesEnabledGranularitiesInner +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList +from gooddata_api_client.model.json_api_fiscal_calendar_out_with_links import JsonApiFiscalCalendarOutWithLinks from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument @@ -868,6 +891,17 @@ from gooddata_api_client.model.json_api_notification_channel_post_optional_id import JsonApiNotificationChannelPostOptionalId from gooddata_api_client.model.json_api_notification_channel_post_optional_id_document import JsonApiNotificationChannelPostOptionalIdDocument from gooddata_api_client.model.json_api_notification_channel_to_one_linkage import JsonApiNotificationChannelToOneLinkage +from gooddata_api_client.model.json_api_org_memory_item_in import JsonApiOrgMemoryItemIn +from gooddata_api_client.model.json_api_org_memory_item_in_attributes import JsonApiOrgMemoryItemInAttributes +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out import JsonApiOrgMemoryItemOut +from gooddata_api_client.model.json_api_org_memory_item_out_attributes import JsonApiOrgMemoryItemOutAttributes +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_out_with_links import JsonApiOrgMemoryItemOutWithLinks +from gooddata_api_client.model.json_api_org_memory_item_patch import JsonApiOrgMemoryItemPatch +from gooddata_api_client.model.json_api_org_memory_item_patch_attributes import JsonApiOrgMemoryItemPatchAttributes +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument from gooddata_api_client.model.json_api_organization_in import JsonApiOrganizationIn from gooddata_api_client.model.json_api_organization_in_attributes import JsonApiOrganizationInAttributes from gooddata_api_client.model.json_api_organization_in_document import JsonApiOrganizationInDocument @@ -993,6 +1027,14 @@ from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships from gooddata_api_client.model.json_api_workspace_automation_out_relationships_workspace import JsonApiWorkspaceAutomationOutRelationshipsWorkspace from gooddata_api_client.model.json_api_workspace_automation_out_with_links import JsonApiWorkspaceAutomationOutWithLinks +from gooddata_api_client.model.json_api_workspace_color_palette_in import JsonApiWorkspaceColorPaletteIn +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out import JsonApiWorkspaceColorPaletteOut +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +from gooddata_api_client.model.json_api_workspace_color_palette_out_with_links import JsonApiWorkspaceColorPaletteOutWithLinks +from gooddata_api_client.model.json_api_workspace_color_palette_patch import JsonApiWorkspaceColorPalettePatch +from gooddata_api_client.model.json_api_workspace_color_palette_patch_document import JsonApiWorkspaceColorPalettePatchDocument from gooddata_api_client.model.json_api_workspace_data_filter_in import JsonApiWorkspaceDataFilterIn from gooddata_api_client.model.json_api_workspace_data_filter_in_attributes import JsonApiWorkspaceDataFilterInAttributes from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument @@ -1020,6 +1062,20 @@ from gooddata_api_client.model.json_api_workspace_data_filter_setting_to_many_linkage import JsonApiWorkspaceDataFilterSettingToManyLinkage from gooddata_api_client.model.json_api_workspace_data_filter_to_many_linkage import JsonApiWorkspaceDataFilterToManyLinkage from gooddata_api_client.model.json_api_workspace_data_filter_to_one_linkage import JsonApiWorkspaceDataFilterToOneLinkage +from gooddata_api_client.model.json_api_workspace_export_template_in import JsonApiWorkspaceExportTemplateIn +from gooddata_api_client.model.json_api_workspace_export_template_in_attributes import JsonApiWorkspaceExportTemplateInAttributes +from gooddata_api_client.model.json_api_workspace_export_template_in_attributes_dashboard_slides_template import JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate +from gooddata_api_client.model.json_api_workspace_export_template_in_attributes_widget_slides_template import JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate +from gooddata_api_client.model.json_api_workspace_export_template_in_document import JsonApiWorkspaceExportTemplateInDocument +from gooddata_api_client.model.json_api_workspace_export_template_out import JsonApiWorkspaceExportTemplateOut +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +from gooddata_api_client.model.json_api_workspace_export_template_out_with_links import JsonApiWorkspaceExportTemplateOutWithLinks +from gooddata_api_client.model.json_api_workspace_export_template_patch import JsonApiWorkspaceExportTemplatePatch +from gooddata_api_client.model.json_api_workspace_export_template_patch_attributes import JsonApiWorkspaceExportTemplatePatchAttributes +from gooddata_api_client.model.json_api_workspace_export_template_patch_document import JsonApiWorkspaceExportTemplatePatchDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id import JsonApiWorkspaceExportTemplatePostOptionalId +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_workspace_in import JsonApiWorkspaceIn from gooddata_api_client.model.json_api_workspace_in_attributes import JsonApiWorkspaceInAttributes from gooddata_api_client.model.json_api_workspace_in_attributes_data_source import JsonApiWorkspaceInAttributesDataSource @@ -1027,6 +1083,7 @@ from gooddata_api_client.model.json_api_workspace_in_relationships import JsonApiWorkspaceInRelationships from gooddata_api_client.model.json_api_workspace_linkage import JsonApiWorkspaceLinkage from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut +from gooddata_api_client.model.json_api_workspace_out_attributes import JsonApiWorkspaceOutAttributes from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList from gooddata_api_client.model.json_api_workspace_out_meta import JsonApiWorkspaceOutMeta @@ -1046,6 +1103,14 @@ from gooddata_api_client.model.json_api_workspace_setting_patch_document import JsonApiWorkspaceSettingPatchDocument from gooddata_api_client.model.json_api_workspace_setting_post_optional_id import JsonApiWorkspaceSettingPostOptionalId from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_theme_in import JsonApiWorkspaceThemeIn +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +from gooddata_api_client.model.json_api_workspace_theme_out import JsonApiWorkspaceThemeOut +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +from gooddata_api_client.model.json_api_workspace_theme_out_with_links import JsonApiWorkspaceThemeOutWithLinks +from gooddata_api_client.model.json_api_workspace_theme_patch import JsonApiWorkspaceThemePatch +from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage from gooddata_api_client.model.json_node import JsonNode from gooddata_api_client.model.key_config import KeyConfig @@ -1062,18 +1127,17 @@ from gooddata_api_client.model.list_links import ListLinks from gooddata_api_client.model.list_links_all_of import ListLinksAllOf from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest -from gooddata_api_client.model.list_llm_provider_models_request_provider_config import ListLlmProviderModelsRequestProviderConfig from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.live_feature_flag_configuration import LiveFeatureFlagConfiguration from gooddata_api_client.model.live_features import LiveFeatures from gooddata_api_client.model.live_features_all_of import LiveFeaturesAllOf from gooddata_api_client.model.llm_model import LlmModel -from gooddata_api_client.model.llm_provider_auth import LlmProviderAuth from gooddata_api_client.model.llm_provider_config import LlmProviderConfig from gooddata_api_client.model.local_identifier import LocalIdentifier from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner +from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner from gooddata_api_client.model.match_attribute_filter import MatchAttributeFilter from gooddata_api_client.model.match_attribute_filter_match_attribute_filter import MatchAttributeFilterMatchAttributeFilter from gooddata_api_client.model.matomo_service import MatomoService @@ -1082,7 +1146,6 @@ from gooddata_api_client.model.measure_group_headers import MeasureGroupHeaders from gooddata_api_client.model.measure_header import MeasureHeader from gooddata_api_client.model.measure_item import MeasureItem -from gooddata_api_client.model.measure_item_definition import MeasureItemDefinition from gooddata_api_client.model.measure_result_header import MeasureResultHeader from gooddata_api_client.model.measure_value_condition import MeasureValueCondition from gooddata_api_client.model.measure_value_filter import MeasureValueFilter @@ -1090,6 +1153,10 @@ from gooddata_api_client.model.memory_item_user import MemoryItemUser from gooddata_api_client.model.metric import Metric from gooddata_api_client.model.metric_definition_override import MetricDefinitionOverride +from gooddata_api_client.model.metric_permissions import MetricPermissions +from gooddata_api_client.model.metric_permissions_assignment import MetricPermissionsAssignment +from gooddata_api_client.model.metric_permissions_for_assignee import MetricPermissionsForAssignee +from gooddata_api_client.model.metric_permissions_for_assignee_rule import MetricPermissionsForAssigneeRule from gooddata_api_client.model.metric_record import MetricRecord from gooddata_api_client.model.metric_value_change import MetricValueChange from gooddata_api_client.model.model_test_result import ModelTestResult @@ -1102,6 +1169,7 @@ from gooddata_api_client.model.notification_content import NotificationContent from gooddata_api_client.model.notification_data import NotificationData from gooddata_api_client.model.notification_filter import NotificationFilter +from gooddata_api_client.model.notification_parameter import NotificationParameter from gooddata_api_client.model.notifications import Notifications from gooddata_api_client.model.notifications_meta import NotificationsMeta from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal @@ -1134,6 +1202,7 @@ from gooddata_api_client.model.parameter import Parameter 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.partition_config import PartitionConfig from gooddata_api_client.model.pdf_table_style import PdfTableStyle from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty @@ -1144,9 +1213,6 @@ from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee from gooddata_api_client.model.permissions_for_assignee_rule import PermissionsForAssigneeRule from gooddata_api_client.model.pipe_table import PipeTable -from gooddata_api_client.model.pipe_table_distribution_config import PipeTableDistributionConfig -from gooddata_api_client.model.pipe_table_key_config import PipeTableKeyConfig -from gooddata_api_client.model.pipe_table_partition_config import PipeTablePartitionConfig from gooddata_api_client.model.pipe_table_summary import PipeTableSummary from gooddata_api_client.model.platform_usage import PlatformUsage from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest @@ -1218,6 +1284,7 @@ from gooddata_api_client.model.scan_result_pdm import ScanResultPdm from gooddata_api_client.model.scan_sql_request import ScanSqlRequest from gooddata_api_client.model.scan_sql_response import ScanSqlResponse +from gooddata_api_client.model.schedule_cache_retention import ScheduleCacheRetention from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject from gooddata_api_client.model.search_request import SearchRequest from gooddata_api_client.model.search_result import SearchResult @@ -1247,6 +1314,7 @@ from gooddata_api_client.model.static_features import StaticFeatures from gooddata_api_client.model.static_features_all_of import StaticFeaturesAllOf from gooddata_api_client.model.string_constraints import StringConstraints +from gooddata_api_client.model.string_parameter_allowed_value import StringParameterAllowedValue from gooddata_api_client.model.string_parameter_definition import StringParameterDefinition from gooddata_api_client.model.succeeded_operation import SucceededOperation from gooddata_api_client.model.succeeded_operation_all_of import SucceededOperationAllOf @@ -1260,6 +1328,7 @@ from gooddata_api_client.model.table_statistics_response import TableStatisticsResponse from gooddata_api_client.model.table_statistics_warning import TableStatisticsWarning from gooddata_api_client.model.table_warning import TableWarning +from gooddata_api_client.model.tabular_export_execution import TabularExportExecution from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.telemetry_config import TelemetryConfig from gooddata_api_client.model.telemetry_context import TelemetryContext @@ -1306,6 +1375,7 @@ 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.validity_period_cache_retention import ValidityPeriodCacheRetention from gooddata_api_client.model.value import Value from gooddata_api_client.model.visible_filter import VisibleFilter from gooddata_api_client.model.visual_export_request import VisualExportRequest @@ -1331,6 +1401,7 @@ from gooddata_api_client.model.workspace_cache_settings import WorkspaceCacheSettings from gooddata_api_client.model.workspace_cache_usage import WorkspaceCacheUsage from gooddata_api_client.model.workspace_current_cache_usage import WorkspaceCurrentCacheUsage +from gooddata_api_client.model.workspace_dashboard_slides_template import WorkspaceDashboardSlidesTemplate from gooddata_api_client.model.workspace_data_source import WorkspaceDataSource from gooddata_api_client.model.workspace_identifier import WorkspaceIdentifier from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment @@ -1338,4 +1409,5 @@ from gooddata_api_client.model.workspace_user_group import WorkspaceUserGroup from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups from gooddata_api_client.model.workspace_users import WorkspaceUsers +from gooddata_api_client.model.workspace_widget_slides_template import WorkspaceWidgetSlidesTemplate from gooddata_api_client.model.xliff import Xliff diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/layout/notification_channel.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/layout/notification_channel.py index d169d3167..c7adbade4 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/layout/notification_channel.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/organization/layout/notification_channel.py @@ -3,10 +3,23 @@ from attrs import define, field from gooddata_api_client.model.declarative_notification_channel import DeclarativeNotificationChannel +from gooddata_api_client.model.notification_channel_destination import NotificationChannelDestination from gooddata_api_client.model.webhook import Webhook from gooddata_sdk.catalog.base import Base +# The generator collapses the `type` enums of NotificationChannelDestination's oneOf children +# into the last child's single value (IN_PLATFORM), so valid destinations of the other types +# fail client-side validation on both serialization and response parsing. Restore the full set. +NotificationChannelDestination.allowed_values[("type",)].update( + { + "WEBHOOK": "WEBHOOK", + "SMTP": "SMTP", + "DEFAULT_SMTP": "DEFAULT_SMTP", + "IN_PLATFORM": "IN_PLATFORM", + } +) + # TODO: there is an issue with generated client which causes these two classes to fail # type in gooddata_api_client/model/declarative_notification_channel_destination.py contains only WEBHOOK as valid value # @define(kw_only=True) diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py index b37756662..b5c1b02e1 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/export_definition.py @@ -2,9 +2,7 @@ from attrs import define from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition -from gooddata_api_client.model.declarative_export_definition_request_payload import ( - DeclarativeExportDefinitionRequestPayload, -) +from gooddata_api_client.model.export_request import ExportRequest from gooddata_sdk import ExportCustomOverride, ExportSettings from gooddata_sdk.catalog.base import Base @@ -25,8 +23,8 @@ class CatalogDeclarativeExportDefinitionRequestPayload(Base): dashboard_id: str | None = None @staticmethod - def client_class() -> type[DeclarativeExportDefinitionRequestPayload]: - return DeclarativeExportDefinitionRequestPayload + def client_class() -> type[ExportRequest]: + return ExportRequest @define(kw_only=True) diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 34444453a..5281f6a6e 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -77,15 +77,15 @@ }, "from": { "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "example": "2020-07-16 23:59:59", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" } }, @@ -102,6 +102,104 @@ ], "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, 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.", + "properties": { + "absoluteGranularityDateFilter": { + "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" + }, + "from": { + "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", + "example": "2012-05", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + }, + "granularity": { + "description": "Granularity determining the filtered date attribute and the expected 'from'/'to' format.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", + "example": "2012-08", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + } + }, + "required": [ + "dataset", + "granularity" + ], + "type": "object" + } + }, + "required": [ + "absoluteGranularityDateFilter" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -270,8 +368,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -388,8 +486,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -516,8 +614,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "aggregate" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "AiUsageMetadataItem": { @@ -570,24 +677,45 @@ "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -651,64 +779,6 @@ ], "type": "object" }, - "AnalyticsCatalogCreatedBy": { - "properties": { - "reasoning": { - "description": "Reasoning for error states", - "type": "string" - }, - "users": { - "description": "Users who created any object in the catalog", - "items": { - "$ref": "#/components/schemas/AnalyticsCatalogUser" - }, - "type": "array" - } - }, - "required": [ - "reasoning", - "users" - ], - "type": "object" - }, - "AnalyticsCatalogTags": { - "properties": { - "tags": { - "items": { - "description": "Tags assigned to any object in the catalog", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "tags" - ], - "type": "object" - }, - "AnalyticsCatalogUser": { - "description": "Users who created any object in the catalog", - "properties": { - "firstname": { - "description": "First name of the user who created any objects", - "type": "string" - }, - "lastname": { - "description": "Last name of the user who created any objects", - "type": "string" - }, - "userId": { - "description": "User ID of the user who created any objects", - "type": "string" - } - }, - "required": [ - "firstname", - "lastname", - "userId" - ], - "type": "object" - }, "AnalyzeStatisticsRequest": { "description": "Request to run ANALYZE TABLE for tables in a database instance", "properties": { @@ -973,24 +1043,45 @@ "granularity": { "description": "Date granularity of the attribute, only filled for date attributes.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -1290,24 +1381,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -1326,6 +1438,23 @@ ], "type": "object" }, + "CertificationInfo": { + "description": "Certification state of the object. Who certified and when are never exposed here.", + "properties": { + "certificationMessage": { + "description": "Optional message describing the certification.", + "type": "string" + }, + "status": { + "description": "Certification status, e.g. CERTIFIED.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, "ChangeAnalysisParams": { "description": "Change analysis specification.", "properties": { @@ -1346,17 +1475,7 @@ "filters": { "description": "Optional filters to apply", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -1423,17 +1542,7 @@ "filters": { "description": "Optional filters to apply.", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -1928,10 +2037,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "column" + ], + "type": "string" } }, "required": [ - "columns" + "columns", + "type" ], "type": "object" }, @@ -2060,7 +2176,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -2098,10 +2213,30 @@ "type": "object" }, "distributionConfig": { - "$ref": "#/components/schemas/DistributionConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/HashDistributionConfig" + }, + { + "$ref": "#/components/schemas/RandomDistributionConfig" + } + ] }, "keyConfig": { - "$ref": "#/components/schemas/KeyConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/AggregateKeyConfig" + }, + { + "$ref": "#/components/schemas/DuplicateKeyConfig" + }, + { + "$ref": "#/components/schemas/PrimaryKeyConfig" + }, + { + "$ref": "#/components/schemas/UniqueKeyConfig" + } + ] }, "maxVarcharLength": { "description": "Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.", @@ -2109,7 +2244,17 @@ "type": "integer" }, "partitionConfig": { - "$ref": "#/components/schemas/PartitionConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/ColumnPartitionConfig" + }, + { + "$ref": "#/components/schemas/DateTruncPartitionConfig" + }, + { + "$ref": "#/components/schemas/TimeSlicePartitionConfig" + } + ] }, "pathPrefix": { "description": "Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.", @@ -2174,7 +2319,7 @@ "$ref": "#/components/schemas/DateRelativeFilter" }, { - "$ref": "#/components/schemas/RankingFilter" + "$ref": "#/components/schemas/GenAiRankingFilter" } ] }, @@ -2245,6 +2390,7 @@ "type": "array" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" }, @@ -2423,6 +2569,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2445,24 +2594,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -2493,6 +2663,12 @@ "description": "Column to partition on.", "type": "string" }, + "type": { + "enum": [ + "dateTrunc" + ], + "type": "string" + }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ @@ -2512,6 +2688,7 @@ }, "required": [ "column", + "type", "unit" ], "type": "object" @@ -2701,8 +2878,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "duplicate" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "Element": { @@ -2792,6 +2978,11 @@ ], "type": "string" }, + "timezone": { + "description": "Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.", + "example": "Europe/Prague", + "type": "string" + }, "validateBy": { "description": "Return only items that are computable on metric.", "items": { @@ -2825,24 +3016,45 @@ "granularity": { "description": "Granularity of requested label in case of date attribute", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -3159,6 +3371,11 @@ "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" + }, + "timezone": { + "description": "Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.", + "example": "Europe/Prague", + "type": "string" } }, "type": "object" @@ -3178,10 +3395,19 @@ } ], "description": "Operation that has failed", + "properties": { + "status": { + "enum": [ + "failed" + ], + "type": "string" + } + }, "required": [ "error", "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -3225,6 +3451,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -3365,6 +3594,7 @@ "type": "array" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" } @@ -3375,6 +3605,47 @@ ], "type": "object" }, + "GenAiRankingFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/Filter" + }, + { + "properties": { + "dimensionality": { + "items": { + "type": "string" + }, + "type": "array" + }, + "measures": { + "items": { + "type": "string" + }, + "type": "array" + }, + "operator": { + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "value": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "required": [ + "measures", + "operator", + "value" + ], + "type": "object" + }, "GenerateDescriptionRequest": { "properties": { "objectId": { @@ -3544,8 +3815,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "hash" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "HeaderGroup": { @@ -3637,12 +3917,19 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "insight" + ], + "type": "string" } }, "required": [ "title", "visualizationId", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -4019,24 +4306,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -4129,20 +4437,7 @@ "ListLlmProviderModelsRequest": { "properties": { "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ @@ -4847,19 +5142,9 @@ "type": "array" }, "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "description": "Various filter types to filter the execution result.", + "items": { + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -4894,7 +5179,6 @@ }, "required": [ "attributes", - "filters", "granularity", "measures", "sensitivity" @@ -4979,6 +5263,7 @@ "type": "object" }, "ParameterItem": { + "additionalProperties": true, "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { @@ -5022,9 +5307,18 @@ } ], "description": "Operation that is still pending", + "properties": { + "status": { + "enum": [ + "pending" + ], + "type": "string" + } + }, "required": [ "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -5314,8 +5608,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "primary" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "ProvisionDatabaseInstanceRequest": { @@ -5466,8 +5769,17 @@ "format": "int32", "minimum": 1, "type": "integer" + }, + "type": { + "enum": [ + "random" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "RangeCondition": { @@ -5710,24 +6022,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -5950,11 +6283,18 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "richText" + ], + "type": "string" } }, "required": [ "title", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -6163,6 +6503,7 @@ "$ref": "#/components/schemas/ErrorInfo" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", "type": "string" }, @@ -6188,6 +6529,9 @@ }, "SearchResultObject": { "properties": { + "certification": { + "$ref": "#/components/schemas/CertificationInfo" + }, "createdAt": { "description": "Timestamp when object was created.", "format": "date-time", @@ -6474,9 +6818,18 @@ } ], "description": "Operation that has succeeded", + "properties": { + "status": { + "enum": [ + "succeeded" + ], + "type": "string" + } + }, "required": [ "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -6508,20 +6861,7 @@ "type": "array" }, "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "type": "object" @@ -6536,20 +6876,7 @@ "type": "array" }, "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ @@ -6608,6 +6935,12 @@ "minimum": 1, "type": "integer" }, + "type": { + "enum": [ + "timeSlice" + ], + "type": "string" + }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ @@ -6628,6 +6961,7 @@ "required": [ "column", "slices", + "type", "unit" ], "type": "object" @@ -6871,11 +7205,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "unique" + ], + "type": "string" } }, - "type": "object" - }, - "Unit": { + "required": [ + "type" + ], "type": "object" }, "UpdateDatabaseDataSourceRequest": { @@ -7021,13 +7361,20 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "visualizationSwitcher" + ], + "type": "string" } }, "required": [ "activeVisualizationId", "title", "visualizationIds", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -7109,17 +7456,7 @@ "properties": { "filters": { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -7228,6 +7565,7 @@ "operationId": "validateLLMEndpoint", "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -7255,6 +7593,7 @@ ], "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -7406,41 +7745,6 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { - "get": { - "description": "Returns a list of Users who created any object for this workspace", - "operationId": "createdBy", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" - } - } - }, - "description": "OK" - } - }, - "summary": "Get Analytics Catalog CreatedBy Users", - "tags": [ - "Smart Functions", - "actions" - ] - } - }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription": { "post": { "description": "Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.", @@ -7531,41 +7835,6 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { - "get": { - "description": "Returns a list of tags for this workspace", - "operationId": "tags", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogTags" - } - } - }, - "description": "OK" - } - }, - "summary": "Get Analytics Catalog Tags", - "tags": [ - "Smart Functions", - "actions" - ] - } - }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { "get": { "description": "Returns a list of trending objects for this workspace", @@ -7941,6 +8210,7 @@ ], "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -8550,7 +8820,17 @@ } } }, - "description": "Execution result was found and returned." + "description": "Execution result was found and returned.", + "headers": { + "X-GDC-RESULT-TOTAL-ROWS": { + "description": "Total number of data rows in the full result.", + "schema": { + "format": "int64", + "type": "integer" + }, + "style": "simple" + } + } } }, "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", @@ -9370,7 +9650,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { "get": { - "description": "(BETA) Gets forecast result.", + "description": "Gets forecast result.", "operationId": "forecastResult", "parameters": [ { @@ -9424,7 +9704,7 @@ "description": "OK" } }, - "summary": "(BETA) Smart functions - Forecast Result", + "summary": "Smart functions - Forecast Result", "tags": [ "Smart Functions", "actions" @@ -9433,7 +9713,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { "post": { - "description": "(BETA) Computes forecasted data points from the provided execution result and parameters.", + "description": "Computes forecasted data points from the provided execution result and parameters.", "operationId": "forecast", "parameters": [ { @@ -9489,7 +9769,7 @@ "description": "OK" } }, - "summary": "(BETA) Smart functions - Forecast", + "summary": "Smart functions - Forecast", "tags": [ "Smart Functions", "actions" @@ -9584,10 +9864,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -9596,11 +9877,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -9665,13 +9947,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -9734,13 +10010,7 @@ ], "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -9852,13 +10122,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Statistics analysis scheduled.", "headers": { "operation-id": { @@ -9956,10 +10220,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -9968,11 +10233,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -10134,10 +10400,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -10146,11 +10413,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -10225,13 +10493,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -10304,13 +10566,7 @@ ], "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -10442,13 +10698,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -10496,10 +10746,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -10508,11 +10759,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -10615,10 +10867,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -10627,11 +10880,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -10714,13 +10968,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index dd9909078..157b8ad4d 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -66,18 +66,7 @@ "filters": { "description": "Various filter types to filter the execution result.", "items": { - "$ref": "#/components/schemas/FilterDefinition", - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -133,15 +122,15 @@ }, "from": { "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "example": "2020-07-16 23:59:59", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" } }, @@ -158,6 +147,104 @@ ], "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, 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.", + "properties": { + "absoluteGranularityDateFilter": { + "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" + }, + "from": { + "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", + "example": "2012-05", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + }, + "granularity": { + "description": "Granularity determining the filtered date attribute and the expected 'from'/'to' format.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", + "example": "2012-08", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + } + }, + "required": [ + "dataset", + "granularity" + ], + "type": "object" + } + }, + "required": [ + "absoluteGranularityDateFilter" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -430,8 +517,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -548,8 +635,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -676,8 +763,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "aggregate" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "AiUsageMetadataItem": { @@ -894,24 +990,45 @@ "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -1003,13 +1120,14 @@ "type": "object" }, "AnalyticsCatalogCreatedBy": { + "description": "List of users who created catalog objects in the workspace hierarchy.", "properties": { "reasoning": { - "description": "Reasoning for error states", + "description": "Reserved for future use. Always empty string in the current implementation.", "type": "string" }, "users": { - "description": "Users who created any object in the catalog", + "description": "Distinct users who have created at least one catalog object.", "items": { "$ref": "#/components/schemas/AnalyticsCatalogUser" }, @@ -1023,10 +1141,11 @@ "type": "object" }, "AnalyticsCatalogTags": { + "description": "List of distinct catalog tags aggregated across the workspace hierarchy.", "properties": { "tags": { + "description": "Sorted, distinct tag strings found in the workspace hierarchy.", "items": { - "description": "Tags assigned to any object in the catalog", "type": "string" }, "type": "array" @@ -1038,18 +1157,21 @@ "type": "object" }, "AnalyticsCatalogUser": { - "description": "Users who created any object in the catalog", + "description": "A user who has created one or more catalog objects.", "properties": { "firstname": { - "description": "First name of the user who created any objects", + "description": "User first name.", + "example": "John", "type": "string" }, "lastname": { - "description": "Last name of the user who created any objects", + "description": "User last name.", + "example": "Doe", "type": "string" }, "userId": { - "description": "User ID of the user who created any objects", + "description": "User identifier.", + "example": "user123", "type": "string" } }, @@ -1425,7 +1547,8 @@ "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", - "AiWorkspaceLimit" + "AiWorkspaceLimit", + "AiObservability" ], "type": "string" }, @@ -1503,6 +1626,8 @@ "description": "Identifier of a user or user-group.", "properties": { "id": { + "description": "Identifier of the assignee.", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { @@ -1697,24 +1822,45 @@ "granularity": { "description": "Date granularity of the attribute, only filled for date attributes.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -1864,20 +2010,7 @@ "AutomationAlert": { "properties": { "condition": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - }, - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - } - ] + "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" @@ -1977,8 +2110,17 @@ "type": "object" } ], + "properties": { + "type": { + "enum": [ + "AUTOMATION" + ], + "type": "string" + } + }, "required": [ - "content" + "content", + "type" ], "type": "object" }, @@ -2234,24 +2376,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -2296,6 +2459,42 @@ ], "type": "object" }, + "CacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. The shape is selected by the `type` property.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + } + ], + "type": "object" + }, + "CacheRetentionSchedule": { + "description": "A schedule determining when the cached results of a data source expire.", + "properties": { + "cron": { + "description": "Cron expression determining when the cached results expire.", + "example": "0 0 5 * * *", + "type": "string" + }, + "timezone": { + "description": "Timezone the cron expression is evaluated in. Defaults to UTC when not set.", + "example": "Europe/Prague", + "nullable": true, + "type": "string" + } + }, + "required": [ + "cron" + ], + "type": "object" + }, "CacheUsageData": { "description": "Result of scan of data source physical model.", "properties": { @@ -2316,6 +2515,140 @@ ], "type": "object" }, + "CalendarDefinition": { + "description": "Fiscal calendar definition. The concrete shape is selected by the `type` discriminator.", + "discriminator": { + "mapping": { + "custom": "#/components/schemas/CustomCalendarDefinition", + "fiscalYear": "#/components/schemas/FiscalYearCalendarDefinition" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCalendarDefinition" + }, + { + "$ref": "#/components/schemas/FiscalYearCalendarDefinition" + } + ], + "type": "object" + }, + "CalendarGranularity": { + "description": "A fiscal granularity enabled in a calendar together with its title prefix.", + "properties": { + "granularity": { + "description": "Fiscal granularity available in the calendar. Corresponds to the calcique granularity name.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "FISCAL_MONTH", + "type": "string" + }, + "prefix": { + "description": "Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism.", + "example": "FP", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "granularity", + "prefix" + ], + "type": "object" + }, + "CalendarTableReference": { + "description": "Reference to a custom fiscal calendar table in a data source.", + "example": { + "path": [ + "schema1", + "table1" + ], + "version": "v1" + }, + "properties": { + "path": { + "description": "Path to the fiscal calendar table.", + "example": [ + "schema1", + "table1" + ], + "items": { + "example": "table1", + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "Version of the fiscal calendar table structure.", + "example": "v1", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "path", + "version" + ], + "type": "object" + }, + "CertificationInfo": { + "description": "Certification state of the object. Who certified and when are never exposed here.", + "properties": { + "certificationMessage": { + "description": "Optional message describing the certification.", + "type": "string" + }, + "status": { + "description": "Certification status, e.g. CERTIFIED.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, "ChangeAnalysisParams": { "description": "Change analysis specification.", "properties": { @@ -2336,17 +2669,7 @@ "filters": { "description": "Optional filters to apply", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -2413,17 +2736,7 @@ "filters": { "description": "Optional filters to apply.", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -2965,10 +3278,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "column" + ], + "type": "string" } }, "required": [ - "columns" + "columns", + "type" ], "type": "object" }, @@ -3299,7 +3619,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -3333,6 +3652,7 @@ "properties": { "location": { "description": "Location of the file in the staging area to convert.", + "minLength": 1, "type": "string" } }, @@ -3404,10 +3724,30 @@ "type": "object" }, "distributionConfig": { - "$ref": "#/components/schemas/DistributionConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/HashDistributionConfig" + }, + { + "$ref": "#/components/schemas/RandomDistributionConfig" + } + ] }, "keyConfig": { - "$ref": "#/components/schemas/KeyConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/AggregateKeyConfig" + }, + { + "$ref": "#/components/schemas/DuplicateKeyConfig" + }, + { + "$ref": "#/components/schemas/PrimaryKeyConfig" + }, + { + "$ref": "#/components/schemas/UniqueKeyConfig" + } + ] }, "maxVarcharLength": { "description": "Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.", @@ -3415,7 +3755,17 @@ "type": "integer" }, "partitionConfig": { - "$ref": "#/components/schemas/PartitionConfig" + "oneOf": [ + { + "$ref": "#/components/schemas/ColumnPartitionConfig" + }, + { + "$ref": "#/components/schemas/DateTruncPartitionConfig" + }, + { + "$ref": "#/components/schemas/TimeSlicePartitionConfig" + } + ] }, "pathPrefix": { "description": "Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.", @@ -3480,7 +3830,7 @@ "$ref": "#/components/schemas/DateRelativeFilter" }, { - "$ref": "#/components/schemas/RankingFilter" + "$ref": "#/components/schemas/GenAiRankingFilter" } ] }, @@ -3551,6 +3901,7 @@ "type": "array" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" }, @@ -3767,6 +4118,45 @@ }, "type": "object" }, + "CustomCalendarDefinition": { + "allOf": [ + { + "properties": { + "dataSourceTables": { + "additionalProperties": { + "$ref": "#/components/schemas/CalendarTableReference" + }, + "description": "Custom fiscal calendar table per data source ID.", + "example": { + "my-postgres": { + "path": [ + "schema1", + "table1" + ], + "version": "v1" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "description": "Calendar backed by custom fiscal calendar tables defined per data source.", + "properties": { + "type": { + "enum": [ + "custom" + ], + "type": "string" + } + }, + "required": [ + "dataSourceTables", + "type" + ], + "type": "object" + }, "CustomLabel": { "description": "Custom label object override.", "properties": { @@ -4092,9 +4482,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -4262,7 +4673,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -4273,32 +4683,6 @@ ], "type": "object" }, - "DashboardParameterValue": { - "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", - "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" - }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" - }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" - } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" - }, "DashboardPermissions": { "properties": { "rules": { @@ -4401,7 +4785,7 @@ "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, @@ -4418,13 +4802,16 @@ "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -4476,7 +4863,7 @@ "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, @@ -4493,13 +4880,16 @@ "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -4867,6 +5257,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -4889,24 +5282,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -4937,6 +5351,12 @@ "description": "Column to partition on.", "type": "string" }, + "type": { + "enum": [ + "dateTrunc" + ], + "type": "string" + }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ @@ -4956,6 +5376,7 @@ }, "required": [ "column", + "type", "unit" ], "type": "object" @@ -5040,7 +5461,7 @@ }, "name": { "description": "Name of the agent.", - "example": "Default GoodData AI Assistant", + "example": "Default AI Assistant", "maxLength": 255, "type": "string" }, @@ -5784,6 +6205,39 @@ ], "type": "object" }, + "DeclarativeCalendar": { + "description": "A custom fiscal calendar definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/CalendarDefinition" + }, + "description": { + "description": "Calendar description.", + "example": "Custom fiscal calendar starting in April.", + "maxLength": 10000, + "type": "string" + }, + "enabledGranularities": { + "description": "Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy.", + "items": { + "$ref": "#/components/schemas/CalendarGranularity" + }, + "type": "array" + }, + "name": { + "description": "Calendar title.", + "example": "Fiscal calendar", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "definition", + "enabledGranularities", + "name" + ], + "type": "object" + }, "DeclarativeColorPalette": { "description": "Color palette and its properties.", "properties": { @@ -6037,11 +6491,14 @@ "TOKEN", "KEY_PAIR", "CLIENT_SECRET", - "ACCESS_TOKEN" + "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, + "cacheRetention": { + "$ref": "#/components/schemas/CacheRetention" + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.\n- ALWAYS: The results from the datasource should be cached normally (the default).\n- NEVER: The results from the datasource should never be cached.", "enum": [ @@ -6405,24 +6862,45 @@ "description": "An array of date granularities. All listed granularities will be available for date dataset.", "items": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -6501,14 +6979,7 @@ "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "requestPayload": { - "oneOf": [ - { - "$ref": "#/components/schemas/TabularExportRequest" - }, - { - "$ref": "#/components/schemas/VisualExportRequest" - } - ] + "$ref": "#/components/schemas/ExportRequest" }, "tags": { "description": "A list of tags.", @@ -7092,6 +7563,13 @@ "DeclarativeLdm": { "description": "A logical data model (LDM) representation.", "properties": { + "calendars": { + "additionalProperties": { + "$ref": "#/components/schemas/DeclarativeCalendar" + }, + "description": "Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace.", + "type": "object" + }, "datasetExtensions": { "description": "An array containing extensions for datasets defined in parent workspaces.", "items": { @@ -7346,20 +7824,7 @@ "type": "string" }, "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] + "$ref": "#/components/schemas/NotificationChannelDestination" }, "destinationType": { "enum": [ @@ -7640,21 +8105,7 @@ "DeclarativeParameter": { "properties": { "content": { - "discriminator": { - "mapping": { - "NUMBER": "#/components/schemas/NumberParameterDefinition", - "STRING": "#/components/schemas/StringParameterDefinition" - }, - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/NumberParameterDefinition" - }, - { - "$ref": "#/components/schemas/StringParameterDefinition" - } - ] + "$ref": "#/components/schemas/ParameterDefinition" }, "createdAt": { "description": "Time of the entity creation.", @@ -7919,6 +8370,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -7939,6 +8391,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -8532,6 +8985,13 @@ "format": "int64", "type": "integer" }, + "colorPalettes": { + "description": "A list of workspace color palettes.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceColorPalette" + }, + "type": "array" + }, "customApplicationSettings": { "description": "A list of workspace custom settings.", "items": { @@ -8562,6 +9022,13 @@ "type": "array", "uniqueItems": true }, + "exportTemplates": { + "description": "A list of workspace export templates.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceExportTemplate" + }, + "type": "array" + }, "filterViews": { "items": { "$ref": "#/components/schemas/DeclarativeFilterView" @@ -8580,6 +9047,11 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "managed": { + "description": "Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled).", + "readOnly": true, + "type": "boolean" + }, "model": { "$ref": "#/components/schemas/DeclarativeWorkspaceModel" }, @@ -8611,6 +9083,13 @@ }, "type": "array" }, + "themes": { + "description": "A list of workspace themes.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceTheme" + }, + "type": "array" + }, "userDataFilters": { "description": "A list of workspace user data filters.", "items": { @@ -8625,6 +9104,27 @@ ], "type": "object" }, + "DeclarativeWorkspaceColorPalette": { + "description": "Workspace color palette and its properties.", + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "id": { + "type": "string" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaceDataFilter": { "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", "properties": { @@ -8794,6 +9294,34 @@ ], "type": "object" }, + "DeclarativeWorkspaceExportTemplate": { + "description": "A declarative form of a workspace export template.", + "properties": { + "dashboardSlidesTemplate": { + "$ref": "#/components/schemas/WorkspaceDashboardSlidesTemplate" + }, + "id": { + "description": "Identifier of a workspace export template", + "example": "default-export-template", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "name": { + "description": "Name of a workspace export template.", + "example": "My default export template", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "$ref": "#/components/schemas/WorkspaceWidgetSlidesTemplate" + } + }, + "required": [ + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaceHierarchyPermission": { "properties": { "assignee": { @@ -8853,6 +9381,27 @@ }, "type": "object" }, + "DeclarativeWorkspaceTheme": { + "description": "Workspace theme and its properties.", + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "id": { + "type": "string" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaces": { "description": "A declarative form of a all workspace layout.", "properties": { @@ -9227,8 +9776,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "duplicate" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "Element": { @@ -9318,6 +9876,11 @@ ], "type": "string" }, + "timezone": { + "description": "Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.", + "example": "Europe/Prague", + "type": "string" + }, "validateBy": { "description": "Return only items that are computable on metric.", "items": { @@ -9351,24 +9914,45 @@ "granularity": { "description": "Granularity of requested label in case of date attribute", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -9424,7 +10008,8 @@ "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", - "AiWorkspaceLimit" + "AiWorkspaceLimit", + "AiObservability" ], "type": "string" }, @@ -9857,6 +10442,11 @@ "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" + }, + "timezone": { + "description": "Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.", + "example": "Europe/Prague", + "type": "string" } }, "type": "object" @@ -9952,10 +10542,19 @@ } ], "description": "Operation that has failed", + "properties": { + "status": { + "enum": [ + "failed" + ], + "type": "string" + } + }, "required": [ "error", "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -10003,16 +10602,25 @@ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "notes": { "$ref": "#/components/schemas/Notes" }, "original": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -10024,7 +10632,11 @@ "$ref": "#/components/schemas/Skeleton" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcDir": { "enum": [ @@ -10032,14 +10644,20 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "translate": { "enum": [ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgDir": { "enum": [ @@ -10047,7 +10665,10 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "unitOrGroup": { "items": { @@ -10056,7 +10677,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "xml": { + "name": "file", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Filter": { "description": "List of filters to be applied to the new visualization", @@ -10098,6 +10723,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -10128,6 +10756,35 @@ ], "type": "object" }, + "FiscalYearCalendarDefinition": { + "allOf": [ + { + "properties": { + "monthOffset": { + "description": "Number of months the fiscal year start is shifted relative to the Gregorian year.", + "example": 3, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "description": "Algorithmic fiscal calendar derived by shifting the Gregorian year start.", + "properties": { + "type": { + "enum": [ + "fiscalYear" + ], + "type": "string" + } + }, + "required": [ + "monthOffset", + "type" + ], + "type": "object" + }, "ForecastConfig": { "description": "Forecast configuration.", "properties": { @@ -10238,6 +10895,7 @@ "type": "array" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" } @@ -10321,6 +10979,47 @@ ], "type": "object" }, + "GenAiRankingFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/Filter" + }, + { + "properties": { + "dimensionality": { + "items": { + "type": "string" + }, + "type": "array" + }, + "measures": { + "items": { + "type": "string" + }, + "type": "array" + }, + "operator": { + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "value": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "required": [ + "measures", + "operator", + "value" + ], + "type": "object" + }, "GenerateDescriptionRequest": { "properties": { "objectId": { @@ -10733,8 +11432,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "hash" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "HeaderGroup": { @@ -10902,7 +11610,12 @@ "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", - "filterView" + "filterView", + "workspaceExportTemplate", + "workspaceTheme", + "workspaceColorPalette", + "fiscalCalendar", + "fiscalCalendarGranularity" ], "type": "string" } @@ -10914,6 +11627,9 @@ "type": "object" } }, + "required": [ + "identifier" + ], "type": "object" }, "ImageExportRequest": { @@ -10940,6 +11656,12 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { @@ -11110,6 +11832,22 @@ ], "type": "object" }, + "IndefiniteCacheRetention": { + "description": "The cache never expires on its own; it is kept per `cacheStrategy` and invalidated only explicitly. Equivalent to setting no policy at all.", + "properties": { + "type": { + "description": "The cache retention type.", + "enum": [ + "INDEFINITE" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "InlineFilterDefinition": { "description": "Filter in form of direct MAQL query.", "properties": { @@ -11183,12 +11921,19 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "insight" + ], + "type": "string" } }, "required": [ "title", "visualizationId", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -13105,24 +13850,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -16489,6 +17255,33 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "authenticationType": { + "description": "Type of authentication used to connect to the database.", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -16679,11 +17472,26 @@ "TOKEN", "KEY_PAIR", "CLIENT_SECRET", - "ACCESS_TOKEN" + "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -16728,6 +17536,10 @@ "nullable": true, "type": "array" }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -16913,6 +17725,33 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "authenticationType": { + "description": "Type of authentication used to connect to the database.", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -19804,6 +20643,193 @@ ], "type": "object" }, + "JsonApiFiscalCalendarOut": { + "description": "A custom fiscal calendar.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "definition": { + "description": "Calendar definition details based on the calendar type.", + "discriminator": { + "mapping": { + "custom": "#/components/schemas/CustomCalendarDefinition", + "fiscalYear": "#/components/schemas/FiscalYearCalendarDefinition" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCalendarDefinition" + }, + { + "$ref": "#/components/schemas/FiscalYearCalendarDefinition" + } + ], + "type": "object" + }, + "description": { + "description": "Calendar description.", + "example": "Custom fiscal calendar starting in April.", + "maxLength": 10000, + "type": "string" + }, + "enabledGranularities": { + "description": "Granularities available in the calendar, in drill-down order (finest to coarsest). Granularity title prefixes are localizable.", + "items": { + "description": "A fiscal granularity enabled in a calendar together with its title prefix.", + "properties": { + "granularity": { + "description": "Fiscal granularity available in the calendar. Corresponds to the calcique granularity name.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "FISCAL_MONTH", + "type": "string" + }, + "prefix": { + "description": "Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism.", + "example": "FP", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "granularity", + "prefix" + ], + "type": "object" + }, + "type": "array" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Calendar title.", + "example": "Fiscal calendar", + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "fiscalCalendar" + ], + "example": "fiscalCalendar", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiFiscalCalendarOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiFiscalCalendarOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiFiscalCalendarOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, "JsonApiIdentityProviderIn": { "description": "JSON:API representation of identityProvider entity.", "properties": { @@ -24091,6 +25117,338 @@ } ] }, + "JsonApiOrgMemoryItemIn": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "instruction", + "strategy" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOut": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "instruction", + "strategy" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiOrgMemoryItemPatch": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiOrganizationIn": { "description": "JSON:API representation of organization entity.", "properties": { @@ -24480,6 +25838,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -24500,6 +25859,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -24581,6 +25941,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -24601,6 +25962,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -24722,6 +26084,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -24742,6 +26105,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -26751,6 +28115,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -26771,6 +28136,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -26852,6 +28218,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -26872,6 +28239,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27949,6 +29317,230 @@ } ] }, + "JsonApiWorkspaceColorPaletteIn": { + "description": "JSON:API representation of workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOut": { + "description": "JSON:API representation of workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { + "properties": { + "origin": { + "properties": { + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" + } + }, + "required": [ + "originId", + "originType" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceColorPalettePatch": { + "description": "JSON:API representation of patching workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPalettePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiWorkspaceDataFilterIn": { "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { @@ -28588,72 +30180,203 @@ } ] }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", + "JsonApiWorkspaceExportTemplateIn": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], "items": { - "description": "The part of the schema path.", - "example": "subPath", + "enum": [ + "PDF", + "PPTX" + ], "type": "string" }, + "minItems": 1, "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ - "id" + "appliedOn" ], "type": "object" }, - "description": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOut": { + "description": "JSON:API representation of workspaceExportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "type": "array" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" }, "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" } }, + "required": [ + "name" + ], "type": "object" }, "id": { @@ -28662,16 +30385,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "parent": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" } }, "required": [ - "data" + "originId", + "originType" ], "type": "object" } @@ -28681,22 +30414,26 @@ "type": { "description": "Object type", "enum": [ - "workspace" + "workspaceExportTemplate" ], - "example": "workspace", + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceInDocument": { + "JsonApiWorkspaceExportTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -28704,65 +30441,446 @@ ], "type": "object" }, - "JsonApiWorkspaceLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "id": { - "type": "string" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "type": { - "enum": [ - "workspace" - ], - "type": "string" + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "id", - "type" + "data" ], "type": "object" }, - "JsonApiWorkspaceOut": { - "description": "JSON:API representation of workspace entity.", + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], "items": { - "description": "The part of the schema path.", - "example": "subPath", + "enum": [ + "PDF", + "PPTX" + ], "type": "string" }, + "minItems": 1, "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ - "id" + "appliedOn" ], "type": "object" }, - "description": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePostOptionalId": { + "description": "JSON:API representation of workspaceExportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceIn": { + "description": "JSON:API representation of workspace entity.", + "properties": { + "attributes": { + "properties": { + "cacheExtraLimit": { + "format": "int64", + "type": "integer" + }, + "dataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" + }, + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items": { + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "description": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccess": { + "deprecated": true, + "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "prefix": { + "description": "Custom prefix of entity identifiers in workspace", + "maxLength": 255, + "nullable": true, + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspace" + ], + "example": "workspace", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "workspace" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceOut": { + "description": "JSON:API representation of workspace entity.", + "properties": { + "attributes": { + "properties": { + "cacheExtraLimit": { + "format": "int64", + "type": "integer" + }, + "dataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" + }, + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items": { + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "description": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccess": { + "deprecated": true, + "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" @@ -28776,6 +30894,10 @@ "nullable": true, "type": "array" }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, "name": { "maxLength": 255, "nullable": true, @@ -29120,6 +31242,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -29140,6 +31263,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -29221,6 +31345,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -29241,6 +31366,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -29388,6 +31514,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -29408,6 +31535,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -29489,6 +31617,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -29509,6 +31638,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -29551,6 +31681,230 @@ ], "type": "object" }, + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { + "properties": { + "origin": { + "properties": { + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" + } + }, + "required": [ + "originId", + "originType" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiWorkspaceToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, @@ -29601,24 +31955,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -29845,20 +32220,7 @@ "ListLlmProviderModelsRequest": { "properties": { "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ @@ -29956,17 +32318,6 @@ ], "type": "object" }, - "LlmProviderAuth": { - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "LlmProviderConfig": { "description": "Provider configuration overrides.", "oneOf": [ @@ -30165,27 +32516,7 @@ "description": "Metric is a quantity that is calculated from the data.", "properties": { "definition": { - "$ref": "#/components/schemas/MeasureDefinition", - "oneOf": [ - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - } - ] + "$ref": "#/components/schemas/MeasureDefinition" }, "localIdentifier": { "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", @@ -30343,6 +32674,99 @@ ], "type": "object" }, + "MetricPermissions": { + "properties": { + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" + }, + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" + }, + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" + } + }, + "required": [ + "rules", + "userGroups", + "users" + ], + "type": "object" + }, + "MetricPermissionsAssignment": { + "description": "Desired levels of permissions on a metric for an assignee.", + "properties": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "MetricPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Desired levels of metric permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "MetricPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, "MetricRecord": { "properties": { "formattedValue": { @@ -30493,16 +32917,25 @@ "SOURCE", "TARGET" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "category": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "content": { "type": "string" }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -30512,10 +32945,17 @@ }, "priority": { "format": "int32", - "type": "integer" + "type": "integer", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Notes": { "properties": { @@ -30526,7 +32966,14 @@ "type": "array" } }, - "type": "object" + "required": [ + "note" + ], + "type": "object", + "xml": { + "name": "notes", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Notification": { "properties": { @@ -30615,6 +33062,24 @@ ], "type": "object" }, + "NotificationParameter": { + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "id", + "value" + ], + "type": "object" + }, "Notifications": { "properties": { "data": { @@ -31069,17 +33534,7 @@ "filters": { "description": "Various filter types to filter the execution result.", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -31114,7 +33569,6 @@ }, "required": [ "attributes", - "filters", "granularity", "measures", "sensitivity" @@ -31272,6 +33726,7 @@ "type": "object" }, "ParameterItem": { + "additionalProperties": true, "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { @@ -31288,6 +33743,33 @@ ], "type": "object" }, + "ParameterValue": { + "additionalProperties": true, + "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", + "properties": { + "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", + "type": "string" + }, + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" + }, + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + } + }, + "required": [ + "id", + "title", + "value" + ], + "type": "object" + }, "PartitionConfig": { "description": "Partition configuration for the table.", "discriminator": { @@ -31419,9 +33901,18 @@ } ], "description": "Operation that is still pending", + "properties": { + "status": { + "enum": [ + "pending" + ], + "type": "string" + } + }, "required": [ "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -31431,6 +33922,7 @@ "items": { "$ref": "#/components/schemas/AssigneeIdentifier" }, + "minItems": 1, "type": "array" }, "dataSources": { @@ -31819,8 +34311,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "primary" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "Profile": { @@ -32051,8 +34552,17 @@ "format": "int32", "minimum": 1, "type": "integer" + }, + "type": { + "enum": [ + "random" + ], + "type": "string" } }, + "required": [ + "type" + ], "type": "object" }, "Range": { @@ -32603,9 +35113,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -32652,24 +35183,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -32844,6 +35396,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -32864,6 +35417,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -32997,11 +35551,18 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "richText" + ], + "type": "string" } }, "required": [ "title", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -33048,6 +35609,7 @@ }, "kid": { "maxLength": 255, + "minLength": 0, "pattern": "^[^.]", "type": "string" }, @@ -33268,6 +35830,26 @@ ], "type": "object" }, + "ScheduleCacheRetention": { + "description": "The cache expires according to a schedule.", + "properties": { + "schedule": { + "$ref": "#/components/schemas/CacheRetentionSchedule" + }, + "type": { + "description": "The cache retention type.", + "enum": [ + "SCHEDULE" + ], + "type": "string" + } + }, + "required": [ + "schedule", + "type" + ], + "type": "object" + }, "SearchRelationshipObject": { "properties": { "sourceObjectId": { @@ -33408,6 +35990,7 @@ "$ref": "#/components/schemas/ErrorInfo" }, "reasoning": { + "deprecated": true, "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", "type": "string" }, @@ -33433,6 +36016,9 @@ }, "SearchResultObject": { "properties": { + "certification": { + "$ref": "#/components/schemas/CertificationInfo" + }, "createdAt": { "description": "Timestamp when object was created.", "format": "date-time", @@ -33737,10 +36323,17 @@ "type": "array" }, "href": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "skeleton", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "SlidesExportRequest": { "description": "Export request object describing the export properties and metadata for slides exports.", @@ -33773,6 +36366,12 @@ "nullable": true, "type": "string" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "visualizationIds": { "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { @@ -34138,6 +36737,13 @@ }, "StringConstraints": { "properties": { + "allowedValues": { + "items": { + "$ref": "#/components/schemas/StringParameterAllowedValue" + }, + "type": "array", + "uniqueItems": true + }, "maxLength": { "format": "int32", "type": "integer" @@ -34149,6 +36755,20 @@ }, "type": "object" }, + "StringParameterAllowedValue": { + "properties": { + "title": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "value" + ], + "type": "object" + }, "StringParameterDefinition": { "properties": { "constraints": { @@ -34187,9 +36807,18 @@ } ], "description": "Operation that has succeeded", + "properties": { + "status": { + "enum": [ + "succeeded" + ], + "type": "string" + } + }, "required": [ "id", - "kind" + "kind", + "status" ], "type": "object" }, @@ -34382,6 +37011,28 @@ ], "type": "object" }, + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", + "type": "string" + } + }, + "required": [ + "executionResult" + ], + "type": "object" + }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { @@ -34393,6 +37044,16 @@ "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -34432,6 +37093,13 @@ "type": "object" }, "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" + }, + "type": "array" } }, "required": [ @@ -34497,6 +37165,18 @@ "TestDefinitionRequest": { "description": "A request containing all information for testing data source definition.", "properties": { + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string" @@ -34588,20 +37268,7 @@ "description": "Request body with notification channel destination to test.", "properties": { "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] + "$ref": "#/components/schemas/NotificationChannelDestination" }, "externalRecipients": { "description": "External recipients of the test result.", @@ -34629,20 +37296,7 @@ "type": "array" }, "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "type": "object" @@ -34657,20 +37311,7 @@ "type": "array" }, "providerConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ @@ -34717,8 +37358,17 @@ "type": "object" } ], + "properties": { + "type": { + "enum": [ + "TEST" + ], + "type": "string" + } + }, "required": [ - "message" + "message", + "type" ], "type": "object" }, @@ -34746,6 +37396,18 @@ "TestRequest": { "description": "A request containing all information for testing existing data source.", "properties": { + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string" @@ -34843,6 +37505,12 @@ "minimum": 1, "type": "integer" }, + "type": { + "enum": [ + "timeSlice" + ], + "type": "string" + }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ @@ -34863,6 +37531,7 @@ "required": [ "column", "slices", + "type", "unit" ], "type": "object" @@ -35117,11 +37786,17 @@ "type": "string" }, "type": "array" + }, + "type": { + "enum": [ + "unique" + ], + "type": "string" } }, - "type": "object" - }, - "Unit": { + "required": [ + "type" + ], "type": "object" }, "UpdateDatabaseDataSourceRequest": { @@ -35290,6 +37965,15 @@ "UserManagementDataSourcePermissionAssignment": { "description": "Datasource permission assignments for users and userGroups", "properties": { + "accessSource": { + "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP" + ], + "readOnly": true, + "type": "string" + }, "id": { "description": "Id of the datasource", "type": "string" @@ -35507,6 +38191,16 @@ "UserManagementWorkspacePermissionAssignment": { "description": "Workspace permission assignments for users and userGroups", "properties": { + "accessSource": { + "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP", + "HIERARCHY" + ], + "readOnly": true, + "type": "string" + }, "hierarchyPermissions": { "items": { "enum": [ @@ -35608,6 +38302,29 @@ ], "type": "object" }, + "ValidityPeriodCacheRetention": { + "description": "The cache expires once a fixed period elapses since the results were computed.", + "properties": { + "type": { + "description": "The cache retention type.", + "enum": [ + "VALIDITY_PERIOD" + ], + "type": "string" + }, + "validityPeriod": { + "description": "How long the cached results stay valid after they were computed.", + "example": "P1D", + "format": "duration", + "type": "string" + } + }, + "required": [ + "type", + "validityPeriod" + ], + "type": "object" + }, "Value": { "properties": { "value": { @@ -35654,6 +38371,12 @@ "description": "Metadata definition in free-form JSON format.", "example": "{}", "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" } }, "required": [ @@ -35727,13 +38450,20 @@ "widgetId": { "description": "Widget object ID.", "type": "string" + }, + "widgetType": { + "enum": [ + "visualizationSwitcher" + ], + "type": "string" } }, "required": [ "activeVisualizationId", "title", "visualizationIds", - "widgetId" + "widgetId", + "widgetType" ], "type": "object" }, @@ -35925,6 +38655,12 @@ "notificationSource": { "type": "string" }, + "parameters": { + "items": { + "$ref": "#/components/schemas/NotificationParameter" + }, + "type": "array" + }, "rawExports": { "items": { "$ref": "#/components/schemas/ExportResult" @@ -36058,17 +38794,7 @@ "properties": { "filters": { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -36286,6 +39012,44 @@ ], "type": "object" }, + "WorkspaceDashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "WorkspaceDataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { @@ -36463,6 +39227,35 @@ ], "type": "object" }, + "WorkspaceWidgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "Xliff": { "properties": { "file": { @@ -36478,19 +39271,39 @@ "type": "object" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "version": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "required": [ + "file" + ], + "type": "object", + "xml": { + "name": "xliff", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } } } }, @@ -36507,6 +39320,7 @@ "operationId": "validateLLMEndpoint", "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -36534,6 +39348,7 @@ ], "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -37109,6 +39924,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -37483,6 +40299,7 @@ ], "responses": { "204": { + "content": {}, "description": "An upload notification has been successfully registered." } }, @@ -37525,6 +40342,7 @@ }, "responses": { "204": { + "content": {}, "description": "Successful deletion." } }, @@ -37802,6 +40620,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -37837,6 +40656,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38058,6 +40878,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38085,6 +40906,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38110,6 +40932,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38135,6 +40958,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38160,6 +40984,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38175,6 +41000,7 @@ "operationId": "unsubscribeAllAutomations", "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38198,6 +41024,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38228,6 +41055,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38238,21 +41066,27 @@ ] } }, - "/api/v1/actions/organization/metadataSync": { + "/api/v1/actions/organization/reloadObservabilityLayout": { "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.", - "operationId": "metadataSyncOrganization", + "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", + "operationId": "reloadObservabilityLayout", "responses": { - "200": { - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(BETA) Sync organization scope Metadata to other services", + "summary": "Reload the managed AI observability layout", "tags": [ - "AI", - "Metadata Sync", + "AI Observability", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/actions/organization/switchActiveIdentityProvider": { @@ -38271,6 +41105,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38452,6 +41287,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -38478,6 +41314,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -38501,6 +41338,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -38615,6 +41453,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38664,6 +41503,18 @@ "schema": { "type": "string" } + }, + { + "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], "responses": { @@ -38706,6 +41557,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38739,6 +41591,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38850,6 +41703,18 @@ "schema": { "type": "string" } + }, + { + "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], "responses": { @@ -38892,6 +41757,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -38906,12 +41772,10 @@ "operationId": "createdBy", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -39031,12 +41895,10 @@ "operationId": "tags", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -39435,6 +42297,7 @@ ], "responses": { "410": { + "content": {}, "description": "Gone" } }, @@ -39791,6 +42654,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -39885,6 +42749,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -39960,6 +42825,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -39995,6 +42861,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -40066,6 +42933,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -40091,6 +42959,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -40124,6 +42993,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -40191,6 +43061,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -40737,7 +43608,17 @@ } } }, - "description": "Execution result was found and returned." + "description": "Execution result was found and returned.", + "headers": { + "X-GDC-RESULT-TOTAL-ROWS": { + "description": "Total number of data rows in the full result.", + "schema": { + "format": "int64", + "type": "integer" + }, + "style": "simple" + } + } } }, "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", @@ -41557,7 +44438,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { "get": { - "description": "(BETA) Gets forecast result.", + "description": "Gets forecast result.", "operationId": "forecastResult", "parameters": [ { @@ -41611,7 +44492,7 @@ "description": "OK" } }, - "summary": "(BETA) Smart functions - Forecast Result", + "summary": "Smart functions - Forecast Result", "tags": [ "Smart Functions", "actions" @@ -41620,7 +44501,7 @@ }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { "post": { - "description": "(BETA) Computes forecasted data points from the provided execution result and parameters.", + "description": "Computes forecasted data points from the provided execution result and parameters.", "operationId": "forecast", "parameters": [ { @@ -41676,7 +44557,7 @@ "description": "OK" } }, - "summary": "(BETA) Smart functions - Forecast", + "summary": "Smart functions - Forecast", "tags": [ "Smart Functions", "actions" @@ -42742,6 +45623,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -42920,6 +45802,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -43000,6 +45883,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -43010,10 +45894,64 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/metadataSync": { + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.", - "operationId": "metadataSync", + "operationId": "manageMetricPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "metricId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of metric-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" + } + ] + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "(BETA) Manage Permissions for a Metric", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { + "get": { + "operationId": "metricPermissions", "parameters": [ { "in": "path", @@ -43022,17 +45960,31 @@ "schema": { "type": "string" } + }, + { + "in": "path", + "name": "metricId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetricPermissions" + } + } + }, "description": "OK" } }, - "summary": "(BETA) Sync Metadata to other services", + "summary": "(BETA) Get Metric Permissions", "tags": [ - "AI", - "Metadata Sync", + "Permissions", "actions" ] } @@ -43217,6 +46169,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -43301,6 +46254,7 @@ }, "responses": { "204": { + "content": {}, "description": "Translations were successfully removed." } }, @@ -43392,6 +46346,7 @@ }, "responses": { "204": { + "content": {}, "description": "Translations were successfully set." } }, @@ -43424,6 +46379,7 @@ ], "responses": { "204": { + "content": {}, "description": "An upload notification has been successfully registered." } }, @@ -43547,7 +46503,7 @@ "style": "form" }, { - "description": "Filter by user name. Note that user name is case insensitive.", + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", "example": "name=charles", "in": "query", "name": "name", @@ -43587,10 +46543,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -43599,11 +46556,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -43668,13 +46626,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -43737,13 +46689,7 @@ ], "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -43855,13 +46801,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Statistics analysis scheduled.", "headers": { "operation-id": { @@ -43959,10 +46899,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -43971,11 +46912,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -44137,10 +47079,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -44149,11 +47092,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -44228,13 +47172,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -44307,13 +47245,7 @@ ], "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -44445,13 +47377,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -44499,10 +47425,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -44511,11 +47438,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -44618,10 +47546,11 @@ "name": "page", "required": false, "schema": { - "default": "0", + "default": 0, "description": "Zero-based page number.", + "format": "int32", "minimum": 0, - "type": "string" + "type": "integer" } }, { @@ -44630,11 +47559,12 @@ "name": "size", "required": false, "schema": { - "default": "50", + "default": 50, "description": "Number of items per page.", + "format": "int32", "maximum": 500, "minimum": 1, - "type": "string" + "type": "integer" } }, { @@ -44717,13 +47647,7 @@ }, "responses": { "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - }, + "content": {}, "description": "Accepted", "headers": { "operation-id": { @@ -47539,7 +50463,13 @@ "Identity Providers", "entities", "identity-provider-controller" - ] + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { "operationId": "createEntity@IdentityProviders", @@ -47653,7 +50583,13 @@ "Identity Providers", "entities", "identity-provider-controller" - ] + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { "operationId": "patchEntity@IdentityProviders", @@ -49288,50 +52224,13 @@ } } }, - "/api/v1/entities/organization": { + "/api/v1/entities/orgMemoryItems": { "get": { - "description": "Gets a basic information about organization.", - "operationId": "getOrganization", - "parameters": [ - { - "description": "Return list of permissions available to logged user.", - "example": "metaInclude=permissions", - "explode": false, - "in": "query", - "name": "metaInclude", - "schema": { - "items": { - "description": "Available meta objects to include.", - "enum": [ - "permissions", - "all" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - } - ], - "responses": { - "302": { - "description": "Redirect to entity URI." - } - }, - "summary": "Get current organization info", - "tags": [ - "Organization - Entity APIs", - "entities" - ] - } - }, - "/api/v1/entities/organization/workspaceAutomations": { - "get": { - "operationId": "getAllAutomations@WorkspaceAutomations", + "operationId": "getAllEntities@OrgMemoryItems", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49340,7 +52239,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -49348,19 +52247,9 @@ "schema": { "items": { "enum": [ - "workspaces", - "notificationChannels", - "analyticalDashboards", "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "workspace", - "notificationChannel", - "analyticalDashboard", "createdBy", "modifiedBy", - "recipients", "ALL" ], "type": "string" @@ -49406,119 +52295,67 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations across all Workspaces", + "summary": "Get all organization Memory Item entities", "tags": [ - "Automations", + "AI", "entities", - "automation-organization-view-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/entities/organizationSettings": { - "get": { - "operationId": "getAllEntities@OrganizationSettings", + }, + "post": { + "description": "Organization-scoped AI memory item", + "operationId": "createEntity@OrgMemoryItems", "parameters": [ { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organization Setting entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "post": { - "operationId": "createEntity@OrganizationSettings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, @@ -49529,23 +52366,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Organization Setting entities", + "summary": "Post organization Memory Item entities", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49555,9 +52392,9 @@ } } }, - "/api/v1/entities/organizationSettings/{id}": { + "/api/v1/entities/orgMemoryItems/{id}": { "delete": { - "operationId": "deleteEntity@OrganizationSettings", + "operationId": "deleteEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -49568,11 +52405,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Organization Setting entity", + "summary": "Delete an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49582,19 +52419,40 @@ } }, "get": { - "operationId": "getEntity@OrganizationSettings", + "operationId": "getEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -49602,57 +52460,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Organization Setting entity", + "summary": "Get an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "patch": { - "operationId": "patchEntity@OrganizationSettings", + "operationId": "patchEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } } }, @@ -49663,23 +52542,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization Setting entity", + "summary": "Patch an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49689,31 +52568,52 @@ } }, "put": { - "operationId": "updateEntity@OrganizationSettings", + "operationId": "updateEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, @@ -49724,23 +52624,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization Setting entity", + "summary": "Put an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49750,13 +52650,475 @@ } } }, - "/api/v1/entities/themes": { + "/api/v1/entities/organization": { "get": { - "operationId": "getAllEntities@Themes", + "description": "Gets a basic information about organization.", + "operationId": "getOrganization", + "parameters": [ + { + "description": "Return list of permissions available to logged user.", + "example": "metaInclude=permissions", + "explode": false, + "in": "query", + "name": "metaInclude", + "schema": { + "items": { + "description": "Available meta objects to include.", + "enum": [ + "permissions", + "all" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "302": { + "description": "Redirect to entity URI." + } + }, + "summary": "Get current organization info", + "tags": [ + "Organization - Entity APIs", + "entities" + ] + } + }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", + "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "automationResults", + "workspace", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Automations across all Workspaces", + "tags": [ + "Automations", + "entities", + "automation-organization-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/organizationSettings": { + "get": { + "operationId": "getAllEntities@OrganizationSettings", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Organization Setting entities", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "operationId": "createEntity@OrganizationSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Organization Setting entities", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/organizationSettings/{id}": { + "delete": { + "operationId": "deleteEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "patch": { + "operationId": "patchEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/themes": { + "get": { + "operationId": "getAllEntities@Themes", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -58536,7 +61898,1863 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "post": { + "operationId": "searchEntities@FilterViews", + "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/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "delete": { + "operationId": "deleteEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + }, + "get": { + "operationId": "getEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + }, + "put": { + "operationId": "updateEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { + "get": { + "operationId": "getAllEntities@FiscalCalendars", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Fiscal Calendars", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { + "get": { + "operationId": "getEntity@FiscalCalendars", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Fiscal Calendar", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "get": { + "operationId": "getAllEntities@KnowledgeRecommendations", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Knowledge Recommendations", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Knowledge Recommendations", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "post": { + "operationId": "searchEntities@KnowledgeRecommendations", + "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/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "delete": { + "operationId": "deleteEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels": { + "get": { + "operationId": "getAllEntities@Labels", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Labels", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "post": { + "operationId": "searchEntities@Labels", + "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/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "get": { + "operationId": "getEntity@Labels", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Label", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@Labels", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Label (beta)", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { + "get": { + "operationId": "getAllEntities@MemoryItems", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -58545,6 +63763,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -58562,23 +63781,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter views", + "summary": "Get all Memory Items", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58588,7 +63807,7 @@ } }, "post": { - "operationId": "createEntity@FilterViews", + "operationId": "createEntity@MemoryItems", "parameters": [ { "in": "path", @@ -58600,7 +63819,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -58608,10 +63827,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -58619,18 +63837,40 @@ "type": "array" }, "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } } }, @@ -58641,35 +63881,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter views", + "summary": "Post Memory Items", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { "post": { - "operationId": "searchEntities@FilterViews", + "operationId": "searchEntities@MemoryItems", "parameters": [ { "in": "path", @@ -58720,12 +63960,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, @@ -58734,9 +63974,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58746,9 +63986,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { "delete": { - "operationId": "deleteEntity@FilterViews", + "operationId": "deleteEntity@MemoryItems", "parameters": [ { "in": "path", @@ -58772,21 +64012,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Filter view", + "summary": "Delete a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@FilterViews", + "operationId": "getEntity@MemoryItems", "parameters": [ { "in": "path", @@ -58806,7 +64046,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -58815,7 +64055,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -58823,10 +64063,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -58843,6 +64082,28 @@ "default": false, "type": "boolean" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -58850,23 +64111,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Filter view", + "summary": "Get a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58876,7 +64137,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterViews", + "operationId": "patchEntity@MemoryItems", "parameters": [ { "in": "path", @@ -58896,7 +64157,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -58905,7 +64166,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -58913,10 +64174,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -58930,12 +64190,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, @@ -58946,33 +64206,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Filter view", + "summary": "Patch a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@FilterViews", + "operationId": "updateEntity@MemoryItems", "parameters": [ { "in": "path", @@ -58992,7 +64252,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59001,7 +64261,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59009,10 +64269,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -59026,12 +64285,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } } }, @@ -59042,35 +64301,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Filter views", + "summary": "Put a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "/api/v1/entities/workspaces/{workspaceId}/metrics": { "get": { - "operationId": "getAllEntities@KnowledgeRecommendations", + "operationId": "getAllEntities@Metrics", "parameters": [ { "in": "path", @@ -59097,7 +64356,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59106,7 +64365,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -59114,10 +64373,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -59173,23 +64438,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Knowledge Recommendations", + "summary": "Get all Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59199,7 +64464,7 @@ } }, "post": { - "operationId": "createEntity@KnowledgeRecommendations", + "operationId": "createEntity@Metrics", "parameters": [ { "in": "path", @@ -59211,7 +64476,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -59219,10 +64484,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -59258,12 +64529,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } } }, @@ -59274,23 +64545,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Knowledge Recommendations", + "summary": "Post Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59300,9 +64571,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { "post": { - "operationId": "searchEntities@KnowledgeRecommendations", + "operationId": "searchEntities@Metrics", "parameters": [ { "in": "path", @@ -59353,12 +64624,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, @@ -59367,9 +64638,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59379,9 +64650,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { "delete": { - "operationId": "deleteEntity@KnowledgeRecommendations", + "operationId": "deleteEntity@Metrics", "parameters": [ { "in": "path", @@ -59405,11 +64676,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Knowledge Recommendation", + "summary": "Delete a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59419,7 +64690,7 @@ } }, "get": { - "operationId": "getEntity@KnowledgeRecommendations", + "operationId": "getEntity@Metrics", "parameters": [ { "in": "path", @@ -59439,7 +64710,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59448,7 +64719,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -59456,10 +64727,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -59505,23 +64782,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Knowledge Recommendation", + "summary": "Get a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59531,7 +64808,7 @@ } }, "patch": { - "operationId": "patchEntity@KnowledgeRecommendations", + "operationId": "patchEntity@Metrics", "parameters": [ { "in": "path", @@ -59551,7 +64828,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59560,7 +64837,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -59568,10 +64845,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -59585,12 +64868,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } } }, @@ -59601,23 +64884,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Knowledge Recommendation", + "summary": "Patch a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59627,7 +64910,7 @@ } }, "put": { - "operationId": "updateEntity@KnowledgeRecommendations", + "operationId": "updateEntity@Metrics", "parameters": [ { "in": "path", @@ -59647,7 +64930,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59656,7 +64939,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -59664,10 +64947,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -59681,12 +64970,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, @@ -59697,23 +64986,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Knowledge Recommendation", + "summary": "Put a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59723,9 +65012,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels": { + "/api/v1/entities/workspaces/{workspaceId}/parameters": { "get": { - "operationId": "getAllEntities@Labels", + "operationId": "getAllEntities@Parameters", "parameters": [ { "in": "path", @@ -59752,7 +65041,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59761,7 +65050,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59769,8 +65058,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -59826,23 +65116,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Labels", + "summary": "Get all Parameters", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59850,11 +65140,111 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Parameters", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { "post": { - "operationId": "searchEntities@Labels", + "operationId": "searchEntities@Parameters", "parameters": [ { "in": "path", @@ -59905,12 +65295,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, @@ -59919,9 +65309,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59931,9 +65321,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "delete": { + "operationId": "deleteEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Labels", + "operationId": "getEntity@Parameters", "parameters": [ { "in": "path", @@ -59953,7 +65381,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59962,7 +65390,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59970,8 +65398,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -60017,23 +65446,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Label", + "summary": "Get a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60043,7 +65472,7 @@ } }, "patch": { - "operationId": "patchEntity@Labels", + "operationId": "patchEntity@Parameters", "parameters": [ { "in": "path", @@ -60063,7 +65492,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -60072,7 +65501,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -60080,8 +65509,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -60095,12 +65525,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } } }, @@ -60111,23 +65541,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60135,11 +65565,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { - "get": { - "operationId": "getAllEntities@MemoryItems", + }, + "put": { + "operationId": "updateEntity@Parameters", "parameters": [ { "in": "path", @@ -60150,17 +65578,10 @@ } }, { - "in": "query", - "name": "origin", - "required": false, + "in": "path", + "name": "objectId", + "required": true, "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], "type": "string" } }, @@ -60193,6 +65614,117 @@ "type": "array" }, "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { + "get": { + "operationId": "getAllEntities@UserDataFilters", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "$ref": "#/components/parameters/page" @@ -60241,23 +65773,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Memory Items", + "summary": "Get all User Data Filters", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60267,7 +65799,7 @@ } }, "post": { - "operationId": "createEntity@MemoryItems", + "operationId": "createEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -60279,7 +65811,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -60287,9 +65819,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -60325,12 +65864,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } } }, @@ -60341,23 +65880,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Memory Items", + "summary": "Post User Data Filters", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60367,9 +65906,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { "post": { - "operationId": "searchEntities@MemoryItems", + "operationId": "searchEntities@UserDataFilters", "parameters": [ { "in": "path", @@ -60420,12 +65959,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, @@ -60434,9 +65973,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60446,9 +65985,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { "delete": { - "operationId": "deleteEntity@MemoryItems", + "operationId": "deleteEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -60472,11 +66011,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Memory Item", + "summary": "Delete a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60486,7 +66025,7 @@ } }, "get": { - "operationId": "getEntity@MemoryItems", + "operationId": "getEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -60506,7 +66045,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -60515,7 +66054,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -60523,9 +66062,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -60571,23 +66117,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Memory Item", + "summary": "Get a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60597,7 +66143,7 @@ } }, "patch": { - "operationId": "patchEntity@MemoryItems", + "operationId": "patchEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -60617,7 +66163,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -60626,7 +66172,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -60634,9 +66180,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -60650,12 +66203,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } } }, @@ -60666,23 +66219,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Memory Item", + "summary": "Patch a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60692,7 +66245,7 @@ } }, "put": { - "operationId": "updateEntity@MemoryItems", + "operationId": "updateEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -60712,7 +66265,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -60721,7 +66274,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -60729,9 +66282,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -60745,12 +66305,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } } }, @@ -60761,23 +66321,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Memory Item", + "summary": "Put a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -60787,9 +66347,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { "get": { - "operationId": "getAllEntities@Metrics", + "operationId": "getAllEntities@VisualizationObjects", "parameters": [ { "in": "path", @@ -60825,7 +66385,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -60838,8 +66398,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -60898,23 +66458,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Metrics", + "summary": "Get all Visualization Objects", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60924,7 +66484,7 @@ } }, "post": { - "operationId": "createEntity@Metrics", + "operationId": "createEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -60936,7 +66496,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -60949,8 +66509,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -60989,12 +66549,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } } }, @@ -61005,35 +66565,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Metrics", + "summary": "Post Visualization Objects", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { "post": { - "operationId": "searchEntities@Metrics", + "operationId": "searchEntities@VisualizationObjects", "parameters": [ { "in": "path", @@ -61084,12 +66644,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, @@ -61098,9 +66658,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61110,9 +66670,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -61136,21 +66696,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -61179,7 +66739,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -61192,8 +66752,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -61242,23 +66802,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61268,7 +66828,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -61297,7 +66857,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -61310,8 +66870,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -61328,12 +66888,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } } }, @@ -61344,33 +66904,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -61399,7 +66959,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -61412,8 +66972,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -61430,12 +66990,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } } }, @@ -61446,35 +67006,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes": { "get": { - "operationId": "getAllEntities@Parameters", + "operationId": "getAllEntities@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -61501,34 +67061,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -61576,23 +67115,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Parameters", + "summary": "Get all Workspace Color Palettes", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" + "workspace-color-palette-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61602,7 +67141,7 @@ } }, "post": { - "operationId": "createEntity@Parameters", + "operationId": "createEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -61612,27 +67151,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -61660,12 +67178,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } } }, @@ -61676,114 +67194,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Parameters", - "tags": [ - "Parameters", - "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { - "post": { - "operationId": "searchEntities@Parameters", - "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/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "workspace-color-palette-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}": { "delete": { - "operationId": "deleteEntity@Parameters", + "operationId": "deleteEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -61807,21 +67240,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Parameter", + "summary": "Delete a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] }, "get": { - "operationId": "getEntity@Parameters", + "operationId": "getEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -61841,34 +67268,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -61906,23 +67312,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Parameter", + "summary": "Get a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" + "workspace-color-palette-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61932,7 +67338,7 @@ } }, "patch": { - "operationId": "patchEntity@Parameters", + "operationId": "patchEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -61952,45 +67358,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatchDocument" } } }, @@ -62001,33 +67386,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Parameter", + "summary": "Patch a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] }, "put": { - "operationId": "updateEntity@Parameters", + "operationId": "updateEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -62047,45 +67426,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } } }, @@ -62096,35 +67454,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Parameter", + "summary": "Put a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { "get": { - "operationId": "getAllEntities@UserDataFilters", + "operationId": "getAllEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62151,7 +67503,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -62160,7 +67512,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -62168,16 +67520,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -62233,23 +67577,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all User Data Filters", + "summary": "Get all Settings for Workspace Data Filters", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62259,7 +67603,7 @@ } }, "post": { - "operationId": "createEntity@UserDataFilters", + "operationId": "createEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62271,7 +67615,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -62279,16 +67623,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -62324,12 +67660,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, @@ -62340,35 +67676,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post User Data Filters", + "summary": "Post Settings for Workspace Data Filters", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { "post": { - "operationId": "searchEntities@UserDataFilters", + "operationId": "searchEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62419,12 +67755,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, @@ -62435,7 +67771,7 @@ "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62445,9 +67781,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@UserDataFilters", + "operationId": "deleteEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62471,21 +67807,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a User Data Filter", + "summary": "Delete a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "get": { - "operationId": "getEntity@UserDataFilters", + "operationId": "getEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62505,7 +67841,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -62514,7 +67850,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -62522,16 +67858,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -62577,23 +67905,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a User Data Filter", + "summary": "Get a Setting for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62603,7 +67931,7 @@ } }, "patch": { - "operationId": "patchEntity@UserDataFilters", + "operationId": "patchEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62623,7 +67951,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -62632,7 +67960,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -62640,16 +67968,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -62663,12 +67983,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } } }, @@ -62679,33 +67999,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a User Data Filter", + "summary": "Patch a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "put": { - "operationId": "updateEntity@UserDataFilters", + "operationId": "updateEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -62725,7 +68045,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -62734,7 +68054,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -62742,16 +68062,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -62765,12 +68077,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, @@ -62781,35 +68093,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a User Data Filter", + "summary": "Put a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { "get": { - "operationId": "getAllEntities@VisualizationObjects", + "operationId": "getAllEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -62836,7 +68148,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -62845,7 +68157,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -62853,16 +68165,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -62918,23 +68222,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Visualization Objects", + "summary": "Get all Workspace Data Filters", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62944,7 +68248,7 @@ } }, "post": { - "operationId": "createEntity@VisualizationObjects", + "operationId": "createEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -62956,7 +68260,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -62964,16 +68268,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -63009,12 +68305,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, @@ -63025,35 +68321,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Visualization Objects", + "summary": "Post Workspace Data Filters", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { "post": { - "operationId": "searchEntities@VisualizationObjects", + "operationId": "searchEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -63104,12 +68400,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, @@ -63118,9 +68414,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63130,9 +68426,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { "delete": { - "operationId": "deleteEntity@VisualizationObjects", + "operationId": "deleteEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -63156,21 +68452,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Visualization Object", + "summary": "Delete a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@VisualizationObjects", + "operationId": "getEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -63190,7 +68486,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -63199,7 +68495,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -63207,16 +68503,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -63262,23 +68550,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Visualization Object", + "summary": "Get a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63288,7 +68576,7 @@ } }, "patch": { - "operationId": "patchEntity@VisualizationObjects", + "operationId": "patchEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -63308,7 +68596,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -63317,7 +68605,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -63325,16 +68613,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -63348,12 +68628,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } } }, @@ -63364,33 +68644,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Visualization Object", + "summary": "Patch a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@VisualizationObjects", + "operationId": "updateEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -63410,7 +68690,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -63419,7 +68699,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -63427,16 +68707,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -63450,12 +68722,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, @@ -63466,35 +68738,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Visualization Object", + "summary": "Put a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates": { "get": { - "operationId": "getAllEntities@WorkspaceDataFilterSettings", + "operationId": "getAllEntities@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -63521,33 +68793,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -63595,23 +68847,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Settings for Workspace Data Filters", + "summary": "Get all Workspace Export Templates", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" + "workspace-export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63621,7 +68873,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceDataFilterSettings", + "operationId": "createEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -63631,26 +68883,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -63678,12 +68910,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalIdDocument" } } }, @@ -63694,114 +68926,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Settings for Workspace Data Filters", + "summary": "Post Workspace Export Template", "tags": [ - "Data Filters", - "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceDataFilterSettings", - "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/JsonApiWorkspaceDataFilterSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "workspace-export-template-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceDataFilterSettings", + "operationId": "deleteEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -63825,21 +68972,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Settings for Workspace Data Filter", + "summary": "Delete a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] }, "get": { - "operationId": "getEntity@WorkspaceDataFilterSettings", + "operationId": "getEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -63859,33 +69000,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -63923,23 +69044,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Setting for Workspace Data Filter", + "summary": "Get a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" + "workspace-export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63949,7 +69070,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceDataFilterSettings", + "operationId": "patchEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -63969,44 +69090,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatchDocument" } } }, @@ -64017,33 +69118,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Settings for Workspace Data Filter", + "summary": "Patch a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] }, "put": { - "operationId": "updateEntity@WorkspaceDataFilterSettings", + "operationId": "updateEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -64063,44 +69158,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateInDocument" } } }, @@ -64111,35 +69186,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Settings for Workspace Data Filter", + "summary": "Put a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { "get": { - "operationId": "getAllEntities@WorkspaceDataFilters", + "operationId": "getAllEntities@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64166,33 +69235,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -64240,23 +69289,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Workspace Data Filters", + "summary": "Get all Setting for Workspaces", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64266,7 +69315,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceDataFilters", + "operationId": "createEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64276,26 +69325,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -64323,12 +69352,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } } }, @@ -64339,35 +69368,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace Data Filters", + "summary": "Post Settings for Workspaces", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { "post": { - "operationId": "searchEntities@WorkspaceDataFilters", + "operationId": "searchEntities@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64418,12 +69441,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, @@ -64432,9 +69455,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64444,9 +69467,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceDataFilters", + "operationId": "deleteEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64470,21 +69493,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Workspace Data Filter", + "summary": "Delete a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] }, "get": { - "operationId": "getEntity@WorkspaceDataFilters", + "operationId": "getEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64504,33 +69521,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -64568,23 +69565,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Workspace Data Filter", + "summary": "Get a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64594,7 +69591,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceDataFilters", + "operationId": "patchEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64614,44 +69611,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } } }, @@ -64662,33 +69639,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Workspace Data Filter", + "summary": "Patch a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] }, "put": { - "operationId": "updateEntity@WorkspaceDataFilters", + "operationId": "updateEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -64708,44 +69679,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } } }, @@ -64756,35 +69707,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Workspace Data Filter", + "summary": "Put a Setting for a Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceThemes": { "get": { - "operationId": "getAllEntities@WorkspaceSettings", + "operationId": "getAllEntities@WorkspaceThemes", "parameters": [ { "in": "path", @@ -64811,7 +69756,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -64865,23 +69810,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Setting for Workspaces", + "summary": "Get all Workspace Themes", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64891,7 +69836,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceSettings", + "operationId": "createEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -64928,12 +69873,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } } }, @@ -64944,108 +69889,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Settings for Workspaces", + "summary": "Post Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceSettings", - "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/JsonApiWorkspaceSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceSettings", + "operationId": "deleteEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -65069,15 +69935,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Setting for Workspace", + "summary": "Delete a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] }, "get": { - "operationId": "getEntity@WorkspaceSettings", + "operationId": "getEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -65097,7 +69963,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -65141,23 +70007,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Setting for Workspace", + "summary": "Get a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65167,7 +70033,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceSettings", + "operationId": "patchEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -65187,7 +70053,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -65199,12 +70065,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatchDocument" } } }, @@ -65215,27 +70081,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Setting for Workspace", + "summary": "Patch a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] }, "put": { - "operationId": "updateEntity@WorkspaceSettings", + "operationId": "updateEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -65255,7 +70121,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -65267,12 +70133,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } } }, @@ -65283,23 +70149,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Setting for a Workspace", + "summary": "Put a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] } }, @@ -65346,6 +70212,7 @@ }, "responses": { "204": { + "content": {}, "description": "All AI agent configurations set." } }, @@ -65405,6 +70272,7 @@ }, "responses": { "204": { + "content": {}, "description": "All custom geo collections set." } }, @@ -65464,6 +70332,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all data sources." } }, @@ -65543,6 +70412,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -65575,6 +70445,7 @@ ], "responses": { "204": { + "content": {}, "description": "Statistics deleted." } }, @@ -65668,6 +70539,7 @@ }, "responses": { "204": { + "content": {}, "description": "Statistics stored successfully." } }, @@ -65727,6 +70599,7 @@ }, "responses": { "204": { + "content": {}, "description": "All export templates set." } }, @@ -65792,6 +70665,7 @@ }, "responses": { "204": { + "content": {}, "description": "All identity providers set." } }, @@ -65851,6 +70725,7 @@ }, "responses": { "204": { + "content": {}, "description": "All notification channels set." } }, @@ -65927,6 +70802,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all parts of an organization." } }, @@ -65993,6 +70869,7 @@ }, "responses": { "204": { + "content": {}, "description": "Organization permissions set." } }, @@ -66052,6 +70929,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all user groups." } }, @@ -66131,6 +71009,7 @@ }, "responses": { "204": { + "content": {}, "description": "User-group permissions successfully set." } }, @@ -66190,6 +71069,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all users." } }, @@ -66269,6 +71149,7 @@ }, "responses": { "204": { + "content": {}, "description": "User permissions successfully set." } }, @@ -66328,6 +71209,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all users and user groups." } }, @@ -66387,6 +71269,7 @@ }, "responses": { "204": { + "content": {}, "description": "All workspace data filters set." } }, @@ -66463,6 +71346,7 @@ }, "responses": { "204": { + "content": {}, "description": "All workspaces layout set." } }, @@ -66557,6 +71441,7 @@ }, "responses": { "204": { + "content": {}, "description": "The model of the workspace was set." } }, @@ -66651,6 +71536,7 @@ }, "responses": { "204": { + "content": {}, "description": "Analytics model successfully set." } }, @@ -66751,6 +71637,7 @@ }, "responses": { "204": { + "content": {}, "description": "Automations successfully set." } }, @@ -66851,6 +71738,7 @@ }, "responses": { "204": { + "content": {}, "description": "FilterViews successfully set." } }, @@ -66938,6 +71826,7 @@ }, "responses": { "204": { + "content": {}, "description": "Logical model successfully set." } }, @@ -67017,6 +71906,7 @@ }, "responses": { "204": { + "content": {}, "description": "Workspace permissions successfully set." } }, @@ -67096,6 +71986,7 @@ }, "responses": { "204": { + "content": {}, "description": "User data filters successfully set." } }, @@ -67175,6 +72066,7 @@ "description": "Features retrieved successfully" }, "404": { + "content": {}, "description": "Collection not found" } }, @@ -67253,6 +72145,7 @@ "description": "Features retrieved successfully" }, "404": { + "content": {}, "description": "Collection not found" } }, diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index d18b1c558..8eb3a2e56 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -21,17 +21,7 @@ "filters": { "description": "Various filter types to filter the execution result.", "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, @@ -87,15 +77,15 @@ }, "from": { "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "example": "2020-07-16 23:59:59", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" } }, @@ -112,6 +102,104 @@ ], "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, 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.", + "properties": { + "absoluteGranularityDateFilter": { + "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" + }, + "from": { + "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", + "example": "2012-05", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + }, + "granularity": { + "description": "Granularity determining the filtered date attribute and the expected 'from'/'to' format.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", + "example": "2012-08", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + } + }, + "required": [ + "dataset", + "granularity" + ], + "type": "object" + } + }, + "required": [ + "absoluteGranularityDateFilter" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -286,8 +374,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -404,8 +492,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -633,24 +721,45 @@ "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -917,20 +1026,7 @@ "AutomationAlert": { "properties": { "condition": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - }, - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - } - ] + "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" @@ -1030,8 +1126,17 @@ "type": "object" } ], + "properties": { + "type": { + "enum": [ + "AUTOMATION" + ], + "type": "string" + } + }, "required": [ - "content" + "content", + "type" ], "type": "object" }, @@ -1092,24 +1197,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -1291,7 +1417,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -1606,9 +1731,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -1776,7 +1922,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -1787,32 +1932,6 @@ ], "type": "object" }, - "DashboardParameterValue": { - "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", - "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" - }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" - }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" - } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" - }, "DashboardTabularExportRequestV2": { "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", "properties": { @@ -1831,7 +1950,7 @@ "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, @@ -1848,13 +1967,16 @@ "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -1895,6 +2017,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2030,6 +2155,11 @@ "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" + }, + "timezone": { + "description": "Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.", + "example": "Europe/Prague", + "type": "string" } }, "type": "object" @@ -2105,6 +2235,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2167,7 +2300,12 @@ "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", - "filterView" + "filterView", + "workspaceExportTemplate", + "workspaceTheme", + "workspaceColorPalette", + "fiscalCalendar", + "fiscalCalendarGranularity" ], "type": "string" } @@ -2179,6 +2317,9 @@ "type": "object" } }, + "required": [ + "identifier" + ], "type": "object" }, "ImageExportRequest": { @@ -2205,6 +2346,12 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { @@ -2399,26 +2546,7 @@ "description": "Metric is a quantity that is calculated from the data.", "properties": { "definition": { - "oneOf": [ - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - } - ] + "$ref": "#/components/schemas/MeasureDefinition" }, "localIdentifier": { "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", @@ -2612,6 +2740,24 @@ ], "type": "object" }, + "NotificationParameter": { + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "id", + "value" + ], + "type": "object" + }, "Notifications": { "properties": { "data": { @@ -2670,6 +2816,7 @@ "type": "object" }, "ParameterItem": { + "additionalProperties": true, "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { @@ -2686,6 +2833,33 @@ ], "type": "object" }, + "ParameterValue": { + "additionalProperties": true, + "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", + "properties": { + "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", + "type": "string" + }, + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" + }, + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + } + }, + "required": [ + "id", + "title", + "value" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -3209,9 +3383,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -3258,24 +3453,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -3491,6 +3707,12 @@ "nullable": true, "type": "string" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "visualizationIds": { "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { @@ -3571,6 +3793,28 @@ ], "type": "object" }, + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", + "type": "string" + } + }, + "required": [ + "executionResult" + ], + "type": "object" + }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { @@ -3582,6 +3826,16 @@ "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -3621,6 +3875,13 @@ "type": "object" }, "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" + }, + "type": "array" } }, "required": [ @@ -3633,20 +3894,7 @@ "description": "Request body with notification channel destination to test.", "properties": { "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] + "$ref": "#/components/schemas/NotificationChannelDestination" }, "externalRecipients": { "description": "External recipients of the test result.", @@ -3678,8 +3926,17 @@ "type": "object" } ], + "properties": { + "type": { + "enum": [ + "TEST" + ], + "type": "string" + } + }, "required": [ - "message" + "message", + "type" ], "type": "object" }, @@ -3759,6 +4016,12 @@ "description": "Metadata definition in free-form JSON format.", "example": "{}", "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" } }, "required": [ @@ -3904,6 +4167,12 @@ "notificationSource": { "type": "string" }, + "parameters": { + "items": { + "$ref": "#/components/schemas/NotificationParameter" + }, + "type": "array" + }, "rawExports": { "items": { "$ref": "#/components/schemas/ExportResult" @@ -4178,6 +4447,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -4205,6 +4475,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 77003e436..559faacf7 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -77,15 +77,15 @@ }, "from": { "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "example": "2020-07-16 23:59:59", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" } }, @@ -102,6 +102,104 @@ ], "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, 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.", + "properties": { + "absoluteGranularityDateFilter": { + "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" + }, + "from": { + "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", + "example": "2012-05", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + }, + "granularity": { + "description": "Granularity determining the filtered date attribute and the expected 'from'/'to' format.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", + "example": "2012-08", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + } + }, + "required": [ + "dataset", + "granularity" + ], + "type": "object" + } + }, + "required": [ + "absoluteGranularityDateFilter" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -172,8 +270,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -290,8 +388,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -355,24 +453,45 @@ "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -576,24 +695,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -737,7 +877,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -1052,9 +1191,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -1222,7 +1382,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -1233,32 +1392,6 @@ ], "type": "object" }, - "DashboardParameterValue": { - "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", - "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" - }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" - }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" - } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" - }, "DashboardTabularExportRequest": { "description": "Export request object describing the export properties for dashboard tabular exports.", "properties": { @@ -1272,7 +1405,7 @@ "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, @@ -1289,13 +1422,16 @@ "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -1335,6 +1471,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -1371,6 +1510,11 @@ "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" + }, + "timezone": { + "description": "Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.", + "example": "Europe/Prague", + "type": "string" } }, "type": "object" @@ -1407,6 +1551,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -1469,7 +1616,12 @@ "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", - "filterView" + "filterView", + "workspaceExportTemplate", + "workspaceTheme", + "workspaceColorPalette", + "fiscalCalendar", + "fiscalCalendarGranularity" ], "type": "string" } @@ -1481,6 +1633,9 @@ "type": "object" } }, + "required": [ + "identifier" + ], "type": "object" }, "ImageExportRequest": { @@ -1507,6 +1662,12 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { @@ -1764,6 +1925,7 @@ "type": "object" }, "ParameterItem": { + "additionalProperties": true, "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { @@ -1780,6 +1942,33 @@ ], "type": "object" }, + "ParameterValue": { + "additionalProperties": true, + "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", + "properties": { + "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", + "type": "string" + }, + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" + }, + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + } + }, + "required": [ + "id", + "title", + "value" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -2237,9 +2426,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -2286,24 +2496,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -2508,6 +2739,12 @@ "nullable": true, "type": "string" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "visualizationIds": { "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { @@ -2537,6 +2774,28 @@ ], "type": "object" }, + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", + "type": "string" + } + }, + "required": [ + "executionResult" + ], + "type": "object" + }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { @@ -2548,6 +2807,16 @@ "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -2587,6 +2856,13 @@ "type": "object" }, "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" + }, + "type": "array" } }, "required": [ @@ -2612,6 +2888,12 @@ "description": "Metadata definition in free-form JSON format.", "example": "{}", "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" } }, "required": [ diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 9321c0003..73f43e563 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -122,15 +122,15 @@ }, "from": { "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "example": "2020-07-16 23:59:59", + "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2}(:\\d{1,2})?)?$", "type": "string" } }, @@ -147,6 +147,104 @@ ], "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, 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.", + "properties": { + "absoluteGranularityDateFilter": { + "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" + }, + "from": { + "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", + "example": "2012-05", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + }, + "granularity": { + "description": "Granularity determining the filtered date attribute and the expected 'from'/'to' format.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", + "example": "2012-08", + "nullable": true, + "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", + "type": "string" + } + }, + "required": [ + "dataset", + "granularity" + ], + "type": "object" + } + }, + "required": [ + "absoluteGranularityDateFilter" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -217,8 +315,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -335,8 +433,8 @@ } }, "required": [ - "type", - "id" + "id", + "type" ], "type": "object" } @@ -477,24 +575,45 @@ "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -542,6 +661,69 @@ ], "type": "object" }, + "AnalyticsCatalogCreatedBy": { + "description": "List of users who created catalog objects in the workspace hierarchy.", + "properties": { + "reasoning": { + "description": "Reserved for future use. Always empty string in the current implementation.", + "type": "string" + }, + "users": { + "description": "Distinct users who have created at least one catalog object.", + "items": { + "$ref": "#/components/schemas/AnalyticsCatalogUser" + }, + "type": "array" + } + }, + "required": [ + "reasoning", + "users" + ], + "type": "object" + }, + "AnalyticsCatalogTags": { + "description": "List of distinct catalog tags aggregated across the workspace hierarchy.", + "properties": { + "tags": { + "description": "Sorted, distinct tag strings found in the workspace hierarchy.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tags" + ], + "type": "object" + }, + "AnalyticsCatalogUser": { + "description": "A user who has created one or more catalog objects.", + "properties": { + "firstname": { + "description": "User first name.", + "example": "John", + "type": "string" + }, + "lastname": { + "description": "User last name.", + "example": "Doe", + "type": "string" + }, + "userId": { + "description": "User identifier.", + "example": "user123", + "type": "string" + } + }, + "required": [ + "firstname", + "lastname", + "userId" + ], + "type": "object" + }, "AnomalyDetection": { "properties": { "dataset": { @@ -693,7 +875,8 @@ "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", - "AiWorkspaceLimit" + "AiWorkspaceLimit", + "AiObservability" ], "type": "string" }, @@ -771,6 +954,8 @@ "description": "Identifier of a user or user-group.", "properties": { "id": { + "description": "Identifier of the assignee.", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { @@ -938,20 +1123,7 @@ "AutomationAlert": { "properties": { "condition": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - }, - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - } - ] + "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" @@ -1289,24 +1461,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -1325,6 +1518,159 @@ ], "type": "object" }, + "CacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. The shape is selected by the `type` property.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + } + ], + "type": "object" + }, + "CacheRetentionSchedule": { + "description": "A schedule determining when the cached results of a data source expire.", + "properties": { + "cron": { + "description": "Cron expression determining when the cached results expire.", + "example": "0 0 5 * * *", + "type": "string" + }, + "timezone": { + "description": "Timezone the cron expression is evaluated in. Defaults to UTC when not set.", + "example": "Europe/Prague", + "nullable": true, + "type": "string" + } + }, + "required": [ + "cron" + ], + "type": "object" + }, + "CalendarDefinition": { + "description": "Fiscal calendar definition. The concrete shape is selected by the `type` discriminator.", + "discriminator": { + "mapping": { + "custom": "#/components/schemas/CustomCalendarDefinition", + "fiscalYear": "#/components/schemas/FiscalYearCalendarDefinition" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCalendarDefinition" + }, + { + "$ref": "#/components/schemas/FiscalYearCalendarDefinition" + } + ], + "type": "object" + }, + "CalendarGranularity": { + "description": "A fiscal granularity enabled in a calendar together with its title prefix.", + "properties": { + "granularity": { + "description": "Fiscal granularity available in the calendar. Corresponds to the calcique granularity name.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "FISCAL_MONTH", + "type": "string" + }, + "prefix": { + "description": "Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism.", + "example": "FP", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "granularity", + "prefix" + ], + "type": "object" + }, + "CalendarTableReference": { + "description": "Reference to a custom fiscal calendar table in a data source.", + "example": { + "path": [ + "schema1", + "table1" + ], + "version": "v1" + }, + "properties": { + "path": { + "description": "Path to the fiscal calendar table.", + "example": [ + "schema1", + "table1" + ], + "items": { + "example": "table1", + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "Version of the fiscal calendar table structure.", + "example": "v1", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "path", + "version" + ], + "type": "object" + }, "ColumnOverride": { "description": "Table column override.", "properties": { @@ -1566,7 +1912,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -1618,6 +1963,45 @@ }, "type": "object" }, + "CustomCalendarDefinition": { + "allOf": [ + { + "properties": { + "dataSourceTables": { + "additionalProperties": { + "$ref": "#/components/schemas/CalendarTableReference" + }, + "description": "Custom fiscal calendar table per data source ID.", + "example": { + "my-postgres": { + "path": [ + "schema1", + "table1" + ], + "version": "v1" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "description": "Calendar backed by custom fiscal calendar tables defined per data source.", + "properties": { + "type": { + "enum": [ + "custom" + ], + "type": "string" + } + }, + "required": [ + "dataSourceTables", + "type" + ], + "type": "object" + }, "CustomLabel": { "description": "Custom label object override.", "properties": { @@ -1922,9 +2306,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -2092,7 +2497,6 @@ } }, "required": [ - "conditions", "measure" ], "type": "object" @@ -2103,32 +2507,6 @@ ], "type": "object" }, - "DashboardParameterValue": { - "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", - "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" - }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" - }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" - } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" - }, "DashboardPermissions": { "properties": { "rules": { @@ -2236,7 +2614,7 @@ "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, @@ -2253,13 +2631,16 @@ "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/DashboardParameterValue" + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -2461,6 +2842,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -2550,7 +2934,7 @@ }, "name": { "description": "Name of the agent.", - "example": "Default GoodData AI Assistant", + "example": "Default AI Assistant", "maxLength": 255, "type": "string" }, @@ -3294,6 +3678,39 @@ ], "type": "object" }, + "DeclarativeCalendar": { + "description": "A custom fiscal calendar definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/CalendarDefinition" + }, + "description": { + "description": "Calendar description.", + "example": "Custom fiscal calendar starting in April.", + "maxLength": 10000, + "type": "string" + }, + "enabledGranularities": { + "description": "Granularities available in the calendar. Order defines the default drill-down order and mimics the granularity dependency hierarchy.", + "items": { + "$ref": "#/components/schemas/CalendarGranularity" + }, + "type": "array" + }, + "name": { + "description": "Calendar title.", + "example": "Fiscal calendar", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "definition", + "enabledGranularities", + "name" + ], + "type": "object" + }, "DeclarativeColorPalette": { "description": "Color palette and its properties.", "properties": { @@ -3547,11 +3964,14 @@ "TOKEN", "KEY_PAIR", "CLIENT_SECRET", - "ACCESS_TOKEN" + "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, + "cacheRetention": { + "$ref": "#/components/schemas/CacheRetention" + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.\n- ALWAYS: The results from the datasource should be cached normally (the default).\n- NEVER: The results from the datasource should never be cached.", "enum": [ @@ -3915,24 +4335,45 @@ "description": "An array of date granularities. All listed granularities will be available for date dataset.", "items": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -4011,14 +4452,7 @@ "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "requestPayload": { - "oneOf": [ - { - "$ref": "#/components/schemas/TabularExportRequest" - }, - { - "$ref": "#/components/schemas/VisualExportRequest" - } - ] + "$ref": "#/components/schemas/ExportRequest" }, "tags": { "description": "A list of tags.", @@ -4602,6 +5036,13 @@ "DeclarativeLdm": { "description": "A logical data model (LDM) representation.", "properties": { + "calendars": { + "additionalProperties": { + "$ref": "#/components/schemas/DeclarativeCalendar" + }, + "description": "Custom fiscal calendars keyed by calendar ID. Can be defined only in the root workspace.", + "type": "object" + }, "datasetExtensions": { "description": "An array containing extensions for datasets defined in parent workspaces.", "items": { @@ -4856,20 +5297,7 @@ "type": "string" }, "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] + "$ref": "#/components/schemas/NotificationChannelDestination" }, "destinationType": { "enum": [ @@ -5150,21 +5578,7 @@ "DeclarativeParameter": { "properties": { "content": { - "discriminator": { - "mapping": { - "NUMBER": "#/components/schemas/NumberParameterDefinition", - "STRING": "#/components/schemas/StringParameterDefinition" - }, - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/NumberParameterDefinition" - }, - { - "$ref": "#/components/schemas/StringParameterDefinition" - } - ] + "$ref": "#/components/schemas/ParameterDefinition" }, "createdAt": { "description": "Time of the entity creation.", @@ -5429,6 +5843,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -5449,6 +5864,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -6026,6 +6442,13 @@ "format": "int64", "type": "integer" }, + "colorPalettes": { + "description": "A list of workspace color palettes.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceColorPalette" + }, + "type": "array" + }, "customApplicationSettings": { "description": "A list of workspace custom settings.", "items": { @@ -6056,6 +6479,13 @@ "type": "array", "uniqueItems": true }, + "exportTemplates": { + "description": "A list of workspace export templates.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceExportTemplate" + }, + "type": "array" + }, "filterViews": { "items": { "$ref": "#/components/schemas/DeclarativeFilterView" @@ -6074,6 +6504,11 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "managed": { + "description": "Whether the workspace is platform-managed and read-only. Informational on export; ignored on import (the flag is server-controlled).", + "readOnly": true, + "type": "boolean" + }, "model": { "$ref": "#/components/schemas/DeclarativeWorkspaceModel" }, @@ -6105,6 +6540,13 @@ }, "type": "array" }, + "themes": { + "description": "A list of workspace themes.", + "items": { + "$ref": "#/components/schemas/DeclarativeWorkspaceTheme" + }, + "type": "array" + }, "userDataFilters": { "description": "A list of workspace user data filters.", "items": { @@ -6119,6 +6561,27 @@ ], "type": "object" }, + "DeclarativeWorkspaceColorPalette": { + "description": "Workspace color palette and its properties.", + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "id": { + "type": "string" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaceDataFilter": { "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", "properties": { @@ -6288,6 +6751,34 @@ ], "type": "object" }, + "DeclarativeWorkspaceExportTemplate": { + "description": "A declarative form of a workspace export template.", + "properties": { + "dashboardSlidesTemplate": { + "$ref": "#/components/schemas/WorkspaceDashboardSlidesTemplate" + }, + "id": { + "description": "Identifier of a workspace export template", + "example": "default-export-template", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "name": { + "description": "Name of a workspace export template.", + "example": "My default export template", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "$ref": "#/components/schemas/WorkspaceWidgetSlidesTemplate" + } + }, + "required": [ + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaceHierarchyPermission": { "properties": { "assignee": { @@ -6347,6 +6838,27 @@ }, "type": "object" }, + "DeclarativeWorkspaceTheme": { + "description": "Workspace theme and its properties.", + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "id": { + "type": "string" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "name" + ], + "type": "object" + }, "DeclarativeWorkspaces": { "description": "A declarative form of a all workspace layout.", "properties": { @@ -6536,7 +7048,8 @@ "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", - "AiWorkspaceLimit" + "AiWorkspaceLimit", + "AiObservability" ], "type": "string" }, @@ -6687,6 +7200,11 @@ "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" + }, + "timezone": { + "description": "Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.", + "example": "Europe/Prague", + "type": "string" } }, "type": "object" @@ -6750,16 +7268,25 @@ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "notes": { "$ref": "#/components/schemas/Notes" }, "original": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -6771,7 +7298,11 @@ "$ref": "#/components/schemas/Skeleton" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcDir": { "enum": [ @@ -6779,14 +7310,20 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "translate": { "enum": [ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgDir": { "enum": [ @@ -6794,7 +7331,10 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "unitOrGroup": { "items": { @@ -6803,7 +7343,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "xml": { + "name": "file", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "FilterDefinition": { "description": "Abstract filter definition type", @@ -6826,6 +7370,9 @@ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, { "$ref": "#/components/schemas/RelativeDateFilter" }, @@ -6856,6 +7403,35 @@ ], "type": "object" }, + "FiscalYearCalendarDefinition": { + "allOf": [ + { + "properties": { + "monthOffset": { + "description": "Number of months the fiscal year start is shifted relative to the Gregorian year.", + "example": 3, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "description": "Algorithmic fiscal calendar derived by shifting the Gregorian year start.", + "properties": { + "type": { + "enum": [ + "fiscalYear" + ], + "type": "string" + } + }, + "required": [ + "monthOffset", + "type" + ], + "type": "object" + }, "GenerateLdmRequest": { "description": "A request containing all information needed for generation of logical model.", "properties": { @@ -7167,7 +7743,12 @@ "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", - "filterView" + "filterView", + "workspaceExportTemplate", + "workspaceTheme", + "workspaceColorPalette", + "fiscalCalendar", + "fiscalCalendarGranularity" ], "type": "string" } @@ -7179,6 +7760,9 @@ "type": "object" } }, + "required": [ + "identifier" + ], "type": "object" }, "ImageExportRequest": { @@ -7205,6 +7789,12 @@ "metadata": { "$ref": "#/components/schemas/JsonNode" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { @@ -7247,6 +7837,22 @@ ], "type": "object" }, + "IndefiniteCacheRetention": { + "description": "The cache never expires on its own; it is kept per `cacheStrategy` and invalidated only explicitly. Equivalent to setting no policy at all.", + "properties": { + "type": { + "description": "The cache retention type.", + "enum": [ + "INDEFINITE" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, "InlineFilterDefinition": { "description": "Filter in form of direct MAQL query.", "properties": { @@ -9208,24 +9814,45 @@ }, "granularity": { "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "type": "string" @@ -12592,6 +13219,33 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "authenticationType": { + "description": "Type of authentication used to connect to the database.", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -12782,11 +13436,26 @@ "TOKEN", "KEY_PAIR", "CLIENT_SECRET", - "ACCESS_TOKEN" + "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -12831,6 +13500,10 @@ "nullable": true, "type": "array" }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -13016,6 +13689,33 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "authenticationType": { + "description": "Type of authentication used to connect to the database.", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, + "cacheRetention": { + "description": "Determines when the cached results coming from a particular data source expire. When unset, the cache is kept per cacheStrategy and invalidated only explicitly.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/IndefiniteCacheRetention" + }, + { + "$ref": "#/components/schemas/ScheduleCacheRetention" + }, + { + "$ref": "#/components/schemas/ValidityPeriodCacheRetention" + } + ] + }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ @@ -15875,211 +16575,115 @@ ], "type": "object" }, - "JsonApiIdentityProviderIn": { - "description": "JSON:API representation of identityProvider entity.", + "JsonApiFiscalCalendarOut": { + "description": "A custom fiscal calendar.", "properties": { "attributes": { "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", - "maxLength": 10000, - "type": "object" + "areRelationsValid": { + "type": "boolean" }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], - "items": { - "type": "string" + "definition": { + "description": "Calendar definition details based on the calendar type.", + "discriminator": { + "mapping": { + "custom": "#/components/schemas/CustomCalendarDefinition", + "fiscalYear": "#/components/schemas/FiscalYearCalendarDefinition" + }, + "propertyName": "type" }, - "type": "array" - }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" + "oneOf": [ + { + "$ref": "#/components/schemas/CustomCalendarDefinition" + }, + { + "$ref": "#/components/schemas/FiscalYearCalendarDefinition" + } ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, "type": "object" }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - }, - "samlMetadata": { - "description": "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", - "maxLength": 15000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "identityProvider" - ], - "example": "identityProvider", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "identityProvider" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderOut": { - "description": "JSON:API representation of identityProvider entity.", - "properties": { - "attributes": { - "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "description": { + "description": "Calendar description.", + "example": "Custom fiscal calendar starting in April.", "maxLength": 10000, - "type": "object" + "type": "string" }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], + "enabledGranularities": { + "description": "Granularities available in the calendar, in drill-down order (finest to coarsest). Granularity title prefixes are localizable.", "items": { - "type": "string" + "description": "A fiscal granularity enabled in a calendar together with its title prefix.", + "properties": { + "granularity": { + "description": "Fiscal granularity available in the calendar. Corresponds to the calcique granularity name.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "FISCAL_MONTH", + "type": "string" + }, + "prefix": { + "description": "Prefix used to compose granularity titles. Can be localized via the metadata localization mechanism.", + "example": "FP", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "granularity", + "prefix" + ], + "type": "object" }, "type": "array" }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" - ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "tags": { "items": { - "maxLength": 255, "type": "string" }, - "nullable": true, "type": "array" }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", + "title": { + "description": "Calendar title.", + "example": "Fiscal calendar", "maxLength": 255, "type": "string" } @@ -16095,9 +16699,9 @@ "type": { "description": "Object type", "enum": [ - "identityProvider" + "fiscalCalendar" ], - "example": "identityProvider", + "example": "fiscalCalendar", "type": "string" } }, @@ -16107,10 +16711,10 @@ ], "type": "object" }, - "JsonApiIdentityProviderOutDocument": { + "JsonApiFiscalCalendarOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOut" + "$ref": "#/components/schemas/JsonApiFiscalCalendarOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -16121,12 +16725,12 @@ ], "type": "object" }, - "JsonApiIdentityProviderOutList": { + "JsonApiFiscalCalendarOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutWithLinks" }, "type": "array", "uniqueItems": true @@ -16148,18 +16752,301 @@ ], "type": "object" }, - "JsonApiIdentityProviderOutWithLinks": { + "JsonApiFiscalCalendarOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiIdentityProviderOut" + "$ref": "#/components/schemas/JsonApiFiscalCalendarOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiIdentityProviderPatch": { - "description": "JSON:API representation of patching identityProvider entity.", + "JsonApiIdentityProviderIn": { + "description": "JSON:API representation of identityProvider entity.", + "properties": { + "attributes": { + "properties": { + "customClaimMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength": 10000, + "type": "object" + }, + "identifiers": { + "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example": [ + "gooddata.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "idpType": { + "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum": [ + "MANAGED_IDP", + "FIM_IDP", + "DEX_IDP", + "CUSTOM_IDP" + ], + "type": "string" + }, + "oauthClientId": { + "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength": 255, + "type": "string" + }, + "oauthClientSecret": { + "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength": 255, + "type": "string" + }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "oauthIssuerId": { + "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example": "myOidcProvider", + "maxLength": 255, + "type": "string" + }, + "oauthIssuerLocation": { + "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength": 255, + "type": "string" + }, + "oauthSubjectIdClaim": { + "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example": "oid", + "maxLength": 255, + "type": "string" + }, + "samlMetadata": { + "description": "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", + "maxLength": 15000, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "identityProvider" + ], + "example": "identityProvider", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiIdentityProviderInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiIdentityProviderIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiIdentityProviderLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "identityProvider" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiIdentityProviderOut": { + "description": "JSON:API representation of identityProvider entity.", + "properties": { + "attributes": { + "properties": { + "customClaimMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength": 10000, + "type": "object" + }, + "identifiers": { + "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example": [ + "gooddata.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "idpType": { + "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum": [ + "MANAGED_IDP", + "FIM_IDP", + "DEX_IDP", + "CUSTOM_IDP" + ], + "type": "string" + }, + "oauthClientId": { + "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength": 255, + "type": "string" + }, + "oauthCustomAuthAttributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength": 10000, + "type": "object" + }, + "oauthCustomScopes": { + "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "oauthIssuerId": { + "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example": "myOidcProvider", + "maxLength": 255, + "type": "string" + }, + "oauthIssuerLocation": { + "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength": 255, + "type": "string" + }, + "oauthSubjectIdClaim": { + "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example": "oid", + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "identityProvider" + ], + "example": "identityProvider", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiIdentityProviderOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiIdentityProviderOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiIdentityProviderOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiIdentityProviderOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiIdentityProviderOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiIdentityProviderPatch": { + "description": "JSON:API representation of patching identityProvider entity.", "properties": { "attributes": { "properties": { @@ -19890,6 +20777,338 @@ } ] }, + "JsonApiOrgMemoryItemIn": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "instruction", + "strategy" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOut": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "instruction", + "strategy" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiOrgMemoryItemPatch": { + "description": "Organization-scoped AI memory item.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "instruction": { + "description": "The text that will be injected into the system prompt", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether memory item is disabled", + "type": "boolean" + }, + "keywords": { + "description": "Set of unique strings used for semantic similarity filtering", + "items": { + "type": "string" + }, + "type": "array" + }, + "strategy": { + "description": "Strategy defining when the memory item should be applied", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "orgMemoryItem" + ], + "example": "orgMemoryItem", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiOrgMemoryItemPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiOrganizationIn": { "description": "JSON:API representation of organization entity.", "properties": { @@ -20279,6 +21498,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -20299,6 +21519,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -20380,6 +21601,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -20400,6 +21622,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -20521,6 +21744,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -20541,6 +21765,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -22520,6 +23745,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -22540,6 +23766,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -22621,6 +23848,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -22641,6 +23869,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -23718,6 +24947,230 @@ } ] }, + "JsonApiWorkspaceColorPaletteIn": { + "description": "JSON:API representation of workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOut": { + "description": "JSON:API representation of workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { + "properties": { + "origin": { + "properties": { + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" + } + }, + "required": [ + "originId", + "originType" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPaletteOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceColorPalettePatch": { + "description": "JSON:API representation of patching workspaceColorPalette entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceColorPalette" + ], + "example": "workspaceColorPalette", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceColorPalettePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiWorkspaceDataFilterIn": { "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { @@ -24357,72 +25810,203 @@ } ] }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", + "JsonApiWorkspaceExportTemplateIn": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], "items": { - "description": "The part of the schema path.", - "example": "subPath", + "enum": [ + "PDF", + "PPTX" + ], "type": "string" }, + "minItems": 1, "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ - "id" + "appliedOn" ], "type": "object" }, - "description": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOut": { + "description": "JSON:API representation of workspaceExportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "type": "array" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" }, "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" } }, + "required": [ + "name" + ], "type": "object" }, "id": { @@ -24431,16 +26015,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "parent": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" } }, "required": [ - "data" + "originId", + "originType" ], "type": "object" } @@ -24450,22 +26044,26 @@ "type": { "description": "Object type", "enum": [ - "workspace" + "workspaceExportTemplate" ], - "example": "workspace", + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceInDocument": { + "JsonApiWorkspaceExportTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -24473,65 +26071,446 @@ ], "type": "object" }, - "JsonApiWorkspaceLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "id": { - "type": "string" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "type": { - "enum": [ - "workspace" - ], - "type": "string" + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "id", - "type" + "data" ], "type": "object" }, - "JsonApiWorkspaceOut": { - "description": "JSON:API representation of workspace entity.", + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], "items": { - "description": "The part of the schema path.", - "example": "subPath", + "enum": [ + "PDF", + "PPTX" + ], "type": "string" }, + "minItems": 1, "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ - "id" + "appliedOn" ], "type": "object" }, - "description": { + "name": { + "description": "User-facing name of the Slides template.", "maxLength": 255, - "nullable": true, "type": "string" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePostOptionalId": { + "description": "JSON:API representation of workspaceExportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, + "type": "string" + }, + "widgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceIn": { + "description": "JSON:API representation of workspace entity.", + "properties": { + "attributes": { + "properties": { + "cacheExtraLimit": { + "format": "int64", + "type": "integer" + }, + "dataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" + }, + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items": { + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "description": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccess": { + "deprecated": true, + "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "prefix": { + "description": "Custom prefix of entity identifiers in workspace", + "maxLength": 255, + "nullable": true, + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspace" + ], + "example": "workspace", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "workspace" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceOut": { + "description": "JSON:API representation of workspace entity.", + "properties": { + "attributes": { + "properties": { + "cacheExtraLimit": { + "format": "int64", + "type": "integer" + }, + "dataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" + }, + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items": { + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "description": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "earlyAccess": { + "deprecated": true, + "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" @@ -24545,6 +26524,10 @@ "nullable": true, "type": "array" }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, "name": { "maxLength": 255, "nullable": true, @@ -24889,6 +26872,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -24909,6 +26893,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -24990,6 +26975,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -25010,6 +26996,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -25157,6 +27144,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -25177,6 +27165,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -25258,6 +27247,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -25278,6 +27268,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -25320,6 +27311,230 @@ ], "type": "object" }, + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { + "properties": { + "origin": { + "properties": { + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" + } + }, + "required": [ + "originId", + "originType" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "JsonApiWorkspaceToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, @@ -25506,17 +27721,6 @@ ], "type": "object" }, - "LlmProviderAuth": { - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "LocalIdentifier": { "properties": { "format": { @@ -25713,6 +27917,99 @@ ], "type": "object" }, + "MetricPermissions": { + "properties": { + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" + }, + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" + }, + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" + } + }, + "required": [ + "rules", + "userGroups", + "users" + ], + "type": "object" + }, + "MetricPermissionsAssignment": { + "description": "Desired levels of permissions on a metric for an assignee.", + "properties": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "MetricPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Desired levels of metric permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "MetricPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, "NegativeAttributeFilter": { "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { @@ -25754,16 +28051,25 @@ "SOURCE", "TARGET" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "category": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "content": { "type": "string" }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -25773,10 +28079,17 @@ }, "priority": { "format": "int32", - "type": "integer" + "type": "integer", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Notes": { "properties": { @@ -25787,7 +28100,14 @@ "type": "array" } }, - "type": "object" + "required": [ + "note" + ], + "type": "object", + "xml": { + "name": "notes", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "NotificationChannelDestination": { "oneOf": [ @@ -26071,6 +28391,7 @@ "type": "object" }, "ParameterItem": { + "additionalProperties": true, "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { @@ -26087,6 +28408,33 @@ ], "type": "object" }, + "ParameterValue": { + "additionalProperties": true, + "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", + "properties": { + "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", + "type": "string" + }, + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" + }, + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + } + }, + "required": [ + "id", + "title", + "value" + ], + "type": "object" + }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", @@ -26197,6 +28545,7 @@ "items": { "$ref": "#/components/schemas/AssigneeIdentifier" }, + "minItems": 1, "type": "array" }, "dataSources": { @@ -26909,9 +29258,30 @@ "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" }, @@ -26958,24 +29328,45 @@ "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", "HOUR_OF_DAY", + "DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", + "WEEK", "WEEK_OF_YEAR", + "MONTH", "MONTH_OF_YEAR", + "QUARTER", "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", "FISCAL_YEAR" ], "example": "DAY", @@ -27075,6 +29466,7 @@ "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", @@ -27095,6 +29487,7 @@ "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", @@ -27125,6 +29518,7 @@ }, "kid": { "maxLength": 255, + "minLength": 0, "pattern": "^[^.]", "type": "string" }, @@ -27201,6 +29595,26 @@ }, "type": "object" }, + "ScheduleCacheRetention": { + "description": "The cache expires according to a schedule.", + "properties": { + "schedule": { + "$ref": "#/components/schemas/CacheRetentionSchedule" + }, + "type": { + "description": "The cache retention type.", + "enum": [ + "SCHEDULE" + ], + "type": "string" + } + }, + "required": [ + "schedule", + "type" + ], + "type": "object" + }, "SectionSlideTemplate": { "description": "Settings for section slide.", "nullable": true, @@ -27409,10 +29823,17 @@ "type": "array" }, "href": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "skeleton", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "SlidesExportRequest": { "description": "Export request object describing the export properties and metadata for slides exports.", @@ -27445,6 +29866,12 @@ "nullable": true, "type": "string" }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, "visualizationIds": { "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { @@ -27616,6 +30043,13 @@ }, "StringConstraints": { "properties": { + "allowedValues": { + "items": { + "$ref": "#/components/schemas/StringParameterAllowedValue" + }, + "type": "array", + "uniqueItems": true + }, "maxLength": { "format": "int32", "type": "integer" @@ -27627,6 +30061,20 @@ }, "type": "object" }, + "StringParameterAllowedValue": { + "properties": { + "title": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "value" + ], + "type": "object" + }, "StringParameterDefinition": { "properties": { "constraints": { @@ -27722,6 +30170,28 @@ ], "type": "object" }, + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", + "type": "string" + } + }, + "required": [ + "executionResult" + ], + "type": "object" + }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { @@ -27733,6 +30203,16 @@ "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", @@ -27772,6 +30252,13 @@ "type": "object" }, "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" + }, + "type": "array" } }, "required": [ @@ -27915,6 +30402,15 @@ "UserManagementDataSourcePermissionAssignment": { "description": "Datasource permission assignments for users and userGroups", "properties": { + "accessSource": { + "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP" + ], + "readOnly": true, + "type": "string" + }, "id": { "description": "Id of the datasource", "type": "string" @@ -28132,6 +30628,16 @@ "UserManagementWorkspacePermissionAssignment": { "description": "Workspace permission assignments for users and userGroups", "properties": { + "accessSource": { + "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP", + "HIERARCHY" + ], + "readOnly": true, + "type": "string" + }, "hierarchyPermissions": { "items": { "enum": [ @@ -28214,6 +30720,29 @@ ], "type": "object" }, + "ValidityPeriodCacheRetention": { + "description": "The cache expires once a fixed period elapses since the results were computed.", + "properties": { + "type": { + "description": "The cache retention type.", + "enum": [ + "VALIDITY_PERIOD" + ], + "type": "string" + }, + "validityPeriod": { + "description": "How long the cached results stay valid after they were computed.", + "example": "P1D", + "format": "duration", + "type": "string" + } + }, + "required": [ + "type", + "validityPeriod" + ], + "type": "object" + }, "Value": { "properties": { "value": { @@ -28260,6 +30789,12 @@ "description": "Metadata definition in free-form JSON format.", "example": "{}", "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" } }, "required": [ @@ -28380,6 +30915,44 @@ ], "type": "object" }, + "WorkspaceDashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "WorkspaceDataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { @@ -28557,6 +31130,35 @@ ], "type": "object" }, + "WorkspaceWidgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, "Xliff": { "properties": { "file": { @@ -28572,19 +31174,39 @@ "type": "object" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "version": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "required": [ + "file" + ], + "type": "object", + "xml": { + "name": "xliff", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } } } }, @@ -28745,6 +31367,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28772,6 +31395,7 @@ ], "responses": { "204": { + "content": {}, "description": "An upload notification has been successfully registered." } }, @@ -28813,6 +31437,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28848,6 +31473,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28873,6 +31499,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28898,6 +31525,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28923,6 +31551,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28938,6 +31567,7 @@ "operationId": "unsubscribeAllAutomations", "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28961,6 +31591,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -28991,6 +31622,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29001,21 +31633,27 @@ ] } }, - "/api/v1/actions/organization/metadataSync": { + "/api/v1/actions/organization/reloadObservabilityLayout": { "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.", - "operationId": "metadataSyncOrganization", + "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", + "operationId": "reloadObservabilityLayout", "responses": { - "200": { - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(BETA) Sync organization scope Metadata to other services", + "summary": "Reload the managed AI observability layout", "tags": [ - "AI", - "Metadata Sync", + "AI Observability", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, "/api/v1/actions/organization/switchActiveIdentityProvider": { @@ -29034,6 +31672,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29215,6 +31854,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -29241,6 +31881,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -29264,6 +31905,7 @@ }, "responses": { "200": { + "content": {}, "description": "OK" } }, @@ -29378,6 +32020,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29427,6 +32070,18 @@ "schema": { "type": "string" } + }, + { + "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], "responses": { @@ -29469,6 +32124,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29502,6 +32158,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29613,6 +32270,18 @@ "schema": { "type": "string" } + }, + { + "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], "responses": { @@ -29655,6 +32324,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29663,6 +32333,72 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { + "get": { + "description": "Returns a list of Users who created any object for this workspace", + "operationId": "createdBy", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Analytics Catalog CreatedBy Users", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { + "get": { + "description": "Returns a list of tags for this workspace", + "operationId": "tags", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyticsCatalogTags" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Analytics Catalog Tags", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { "get": { "operationId": "availableAssignees", @@ -29747,6 +32483,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29841,6 +32578,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29916,6 +32654,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29951,6 +32690,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -29986,6 +32726,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30011,6 +32752,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30044,6 +32786,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30077,6 +32820,7 @@ ], "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30273,6 +33017,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30451,6 +33196,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30531,6 +33277,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30541,10 +33288,9 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/metadataSync": { + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.", - "operationId": "metadataSync", + "operationId": "manageMetricPermissions", "parameters": [ { "in": "path", @@ -30553,17 +33299,86 @@ "schema": { "type": "string" } + }, + { + "in": "path", + "name": "metricId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of metric-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" + } + ] + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "(BETA) Manage Permissions for a Metric", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { + "get": { + "operationId": "metricPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "metricId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MetricPermissions" + } + } + }, "description": "OK" } }, - "summary": "(BETA) Sync Metadata to other services", + "summary": "(BETA) Get Metric Permissions", "tags": [ - "AI", - "Metadata Sync", + "Permissions", "actions" ] } @@ -30748,6 +33563,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -30832,6 +33648,7 @@ }, "responses": { "204": { + "content": {}, "description": "Translations were successfully removed." } }, @@ -30923,6 +33740,7 @@ }, "responses": { "204": { + "content": {}, "description": "Translations were successfully set." } }, @@ -30955,6 +33773,7 @@ ], "responses": { "204": { + "content": {}, "description": "An upload notification has been successfully registered." } }, @@ -31078,7 +33897,7 @@ "style": "form" }, { - "description": "Filter by user name. Note that user name is case insensitive.", + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", "example": "name=charles", "in": "query", "name": "name", @@ -33847,7 +36666,13 @@ "Identity Providers", "entities", "identity-provider-controller" - ] + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { "operationId": "createEntity@IdentityProviders", @@ -33961,7 +36786,13 @@ "Identity Providers", "entities", "identity-provider-controller" - ] + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { "operationId": "patchEntity@IdentityProviders", @@ -35596,50 +38427,13 @@ } } }, - "/api/v1/entities/organization": { + "/api/v1/entities/orgMemoryItems": { "get": { - "description": "Gets a basic information about organization.", - "operationId": "getOrganization", - "parameters": [ - { - "description": "Return list of permissions available to logged user.", - "example": "metaInclude=permissions", - "explode": false, - "in": "query", - "name": "metaInclude", - "schema": { - "items": { - "description": "Available meta objects to include.", - "enum": [ - "permissions", - "all" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - } - ], - "responses": { - "302": { - "description": "Redirect to entity URI." - } - }, - "summary": "Get current organization info", - "tags": [ - "Organization - Entity APIs", - "entities" - ] - } - }, - "/api/v1/entities/organization/workspaceAutomations": { - "get": { - "operationId": "getAllAutomations@WorkspaceAutomations", + "operationId": "getAllEntities@OrgMemoryItems", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -35648,7 +38442,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -35656,19 +38450,9 @@ "schema": { "items": { "enum": [ - "workspaces", - "notificationChannels", - "analyticalDashboards", "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "workspace", - "notificationChannel", - "analyticalDashboard", "createdBy", "modifiedBy", - "recipients", "ALL" ], "type": "string" @@ -35714,119 +38498,67 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations across all Workspaces", + "summary": "Get all organization Memory Item entities", "tags": [ - "Automations", + "AI", "entities", - "automation-organization-view-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/entities/organizationSettings": { - "get": { - "operationId": "getAllEntities@OrganizationSettings", + }, + "post": { + "description": "Organization-scoped AI memory item", + "operationId": "createEntity@OrgMemoryItems", "parameters": [ { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organization Setting entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "post": { - "operationId": "createEntity@OrganizationSettings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, @@ -35837,23 +38569,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Organization Setting entities", + "summary": "Post organization Memory Item entities", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35863,9 +38595,9 @@ } } }, - "/api/v1/entities/organizationSettings/{id}": { + "/api/v1/entities/orgMemoryItems/{id}": { "delete": { - "operationId": "deleteEntity@OrganizationSettings", + "operationId": "deleteEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -35876,11 +38608,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Organization Setting entity", + "summary": "Delete an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35890,19 +38622,40 @@ } }, "get": { - "operationId": "getEntity@OrganizationSettings", + "operationId": "getEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -35910,57 +38663,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Organization Setting entity", + "summary": "Get an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "patch": { - "operationId": "patchEntity@OrganizationSettings", + "operationId": "patchEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } } }, @@ -35971,23 +38745,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization Setting entity", + "summary": "Patch an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35997,31 +38771,52 @@ } }, "put": { - "operationId": "updateEntity@OrganizationSettings", + "operationId": "updateEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, @@ -36032,23 +38827,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization Setting entity", + "summary": "Put an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "AI", "entities", - "organization-setting-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36058,13 +38853,475 @@ } } }, - "/api/v1/entities/themes": { + "/api/v1/entities/organization": { "get": { - "operationId": "getAllEntities@Themes", + "description": "Gets a basic information about organization.", + "operationId": "getOrganization", + "parameters": [ + { + "description": "Return list of permissions available to logged user.", + "example": "metaInclude=permissions", + "explode": false, + "in": "query", + "name": "metaInclude", + "schema": { + "items": { + "description": "Available meta objects to include.", + "enum": [ + "permissions", + "all" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "302": { + "description": "Redirect to entity URI." + } + }, + "summary": "Get current organization info", + "tags": [ + "Organization - Entity APIs", + "entities" + ] + } + }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", + "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "automationResults", + "workspace", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Automations across all Workspaces", + "tags": [ + "Automations", + "entities", + "automation-organization-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/organizationSettings": { + "get": { + "operationId": "getAllEntities@OrganizationSettings", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Organization Setting entities", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "operationId": "createEntity@OrganizationSettings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Organization Setting entities", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/organizationSettings/{id}": { + "delete": { + "operationId": "deleteEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "patch": { + "operationId": "patchEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@OrganizationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "content==JsonNodeValue;type==SettingTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/themes": { + "get": { + "operationId": "getAllEntities@Themes", + "parameters": [ + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -44844,7 +48101,1863 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "post": { + "operationId": "searchEntities@FilterViews", + "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/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "delete": { + "operationId": "deleteEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + }, + "get": { + "operationId": "getEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch Filter view", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + }, + "put": { + "operationId": "updateEntity@FilterViews", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "analyticalDashboard,user", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "analyticalDashboards", + "users", + "analyticalDashboard", + "user", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put Filter views", + "tags": [ + "Filter Views", + "entities", + "filter-view-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage Filter Views", + "permissions": [ + "CREATE_FILTER_VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { + "get": { + "operationId": "getAllEntities@FiscalCalendars", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Fiscal Calendars", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { + "get": { + "operationId": "getEntity@FiscalCalendars", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Fiscal Calendar", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "get": { + "operationId": "getAllEntities@KnowledgeRecommendations", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Knowledge Recommendations", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Knowledge Recommendations", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "post": { + "operationId": "searchEntities@KnowledgeRecommendations", + "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/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "delete": { + "operationId": "deleteEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Knowledge Recommendation", + "tags": [ + "AI", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels": { + "get": { + "operationId": "getAllEntities@Labels", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Labels", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "post": { + "operationId": "searchEntities@Labels", + "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/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "get": { + "operationId": "getEntity@Labels", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Label", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@Labels", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "attribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "attribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiLabelOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Label (beta)", + "tags": [ + "Labels", + "entities", + "label-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { + "get": { + "operationId": "getAllEntities@MemoryItems", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -44853,6 +49966,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -44870,23 +49984,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter views", + "summary": "Get all Memory Items", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44896,7 +50010,7 @@ } }, "post": { - "operationId": "createEntity@FilterViews", + "operationId": "createEntity@MemoryItems", "parameters": [ { "in": "path", @@ -44908,7 +50022,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -44916,10 +50030,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -44927,18 +50040,40 @@ "type": "array" }, "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } } }, @@ -44949,35 +50084,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter views", + "summary": "Post Memory Items", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { "post": { - "operationId": "searchEntities@FilterViews", + "operationId": "searchEntities@MemoryItems", "parameters": [ { "in": "path", @@ -45028,12 +50163,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, @@ -45042,9 +50177,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45054,9 +50189,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { "delete": { - "operationId": "deleteEntity@FilterViews", + "operationId": "deleteEntity@MemoryItems", "parameters": [ { "in": "path", @@ -45080,21 +50215,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Filter view", + "summary": "Delete a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@FilterViews", + "operationId": "getEntity@MemoryItems", "parameters": [ { "in": "path", @@ -45114,7 +50249,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45123,7 +50258,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -45131,10 +50266,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -45151,6 +50285,28 @@ "default": false, "type": "boolean" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -45158,23 +50314,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Filter view", + "summary": "Get a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45184,7 +50340,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterViews", + "operationId": "patchEntity@MemoryItems", "parameters": [ { "in": "path", @@ -45204,7 +50360,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45213,7 +50369,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -45221,10 +50377,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -45238,12 +50393,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, @@ -45254,33 +50409,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Filter view", + "summary": "Patch a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@FilterViews", + "operationId": "updateEntity@MemoryItems", "parameters": [ { "in": "path", @@ -45300,7 +50455,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45309,7 +50464,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -45317,10 +50472,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -45334,12 +50488,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } } }, @@ -45350,35 +50504,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Filter views", + "summary": "Put a Memory Item", "tags": [ - "Filter Views", + "AI", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "/api/v1/entities/workspaces/{workspaceId}/metrics": { "get": { - "operationId": "getAllEntities@KnowledgeRecommendations", + "operationId": "getAllEntities@Metrics", "parameters": [ { "in": "path", @@ -45405,7 +50559,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45414,7 +50568,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -45422,10 +50576,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -45481,23 +50641,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Knowledge Recommendations", + "summary": "Get all Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45507,7 +50667,7 @@ } }, "post": { - "operationId": "createEntity@KnowledgeRecommendations", + "operationId": "createEntity@Metrics", "parameters": [ { "in": "path", @@ -45519,7 +50679,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -45527,10 +50687,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -45566,12 +50732,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } } }, @@ -45582,23 +50748,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Knowledge Recommendations", + "summary": "Post Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45608,9 +50774,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { "post": { - "operationId": "searchEntities@KnowledgeRecommendations", + "operationId": "searchEntities@Metrics", "parameters": [ { "in": "path", @@ -45661,12 +50827,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, @@ -45675,9 +50841,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45687,9 +50853,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { "delete": { - "operationId": "deleteEntity@KnowledgeRecommendations", + "operationId": "deleteEntity@Metrics", "parameters": [ { "in": "path", @@ -45713,11 +50879,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Knowledge Recommendation", + "summary": "Delete a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45727,7 +50893,7 @@ } }, "get": { - "operationId": "getEntity@KnowledgeRecommendations", + "operationId": "getEntity@Metrics", "parameters": [ { "in": "path", @@ -45747,7 +50913,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45756,7 +50922,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -45764,10 +50930,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -45813,23 +50985,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Knowledge Recommendation", + "summary": "Get a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45839,7 +51011,7 @@ } }, "patch": { - "operationId": "patchEntity@KnowledgeRecommendations", + "operationId": "patchEntity@Metrics", "parameters": [ { "in": "path", @@ -45859,7 +51031,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45868,7 +51040,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -45876,10 +51048,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -45893,12 +51071,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } } }, @@ -45909,23 +51087,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Knowledge Recommendation", + "summary": "Patch a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -45935,7 +51113,7 @@ } }, "put": { - "operationId": "updateEntity@KnowledgeRecommendations", + "operationId": "updateEntity@Metrics", "parameters": [ { "in": "path", @@ -45955,7 +51133,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -45964,7 +51142,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -45972,10 +51150,16 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -45989,12 +51173,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, @@ -46005,23 +51189,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Knowledge Recommendation", + "summary": "Put a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -46031,9 +51215,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels": { + "/api/v1/entities/workspaces/{workspaceId}/parameters": { "get": { - "operationId": "getAllEntities@Labels", + "operationId": "getAllEntities@Parameters", "parameters": [ { "in": "path", @@ -46060,7 +51244,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -46069,7 +51253,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -46077,8 +51261,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -46134,23 +51319,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Labels", + "summary": "Get all Parameters", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46158,11 +51343,111 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Parameters", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { "post": { - "operationId": "searchEntities@Labels", + "operationId": "searchEntities@Parameters", "parameters": [ { "in": "path", @@ -46213,12 +51498,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, @@ -46227,9 +51512,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46239,9 +51524,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "delete": { + "operationId": "deleteEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Labels", + "operationId": "getEntity@Parameters", "parameters": [ { "in": "path", @@ -46261,7 +51584,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -46270,7 +51593,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -46278,8 +51601,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -46325,23 +51649,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Label", + "summary": "Get a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46351,7 +51675,7 @@ } }, "patch": { - "operationId": "patchEntity@Labels", + "operationId": "patchEntity@Parameters", "parameters": [ { "in": "path", @@ -46371,7 +51695,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -46380,7 +51704,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -46388,8 +51712,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -46403,12 +51728,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } } }, @@ -46419,23 +51744,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -46443,11 +51768,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { - "get": { - "operationId": "getAllEntities@MemoryItems", + }, + "put": { + "operationId": "updateEntity@Parameters", "parameters": [ { "in": "path", @@ -46458,17 +51781,10 @@ } }, { - "in": "query", - "name": "origin", - "required": false, + "in": "path", + "name": "objectId", + "required": true, "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], "type": "string" } }, @@ -46501,6 +51817,117 @@ "type": "array" }, "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { + "get": { + "operationId": "getAllEntities@UserDataFilters", + "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" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "$ref": "#/components/parameters/page" @@ -46549,23 +51976,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Memory Items", + "summary": "Get all User Data Filters", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46575,7 +52002,7 @@ } }, "post": { - "operationId": "createEntity@MemoryItems", + "operationId": "createEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -46587,7 +52014,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -46595,9 +52022,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -46633,12 +52067,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } } }, @@ -46649,23 +52083,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Memory Items", + "summary": "Post User Data Filters", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -46675,9 +52109,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { "post": { - "operationId": "searchEntities@MemoryItems", + "operationId": "searchEntities@UserDataFilters", "parameters": [ { "in": "path", @@ -46728,12 +52162,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, @@ -46742,9 +52176,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46754,9 +52188,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { "delete": { - "operationId": "deleteEntity@MemoryItems", + "operationId": "deleteEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -46780,11 +52214,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Memory Item", + "summary": "Delete a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -46794,7 +52228,7 @@ } }, "get": { - "operationId": "getEntity@MemoryItems", + "operationId": "getEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -46814,7 +52248,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -46823,7 +52257,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -46831,9 +52265,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -46879,23 +52320,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Memory Item", + "summary": "Get a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46905,7 +52346,7 @@ } }, "patch": { - "operationId": "patchEntity@MemoryItems", + "operationId": "patchEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -46925,7 +52366,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -46934,7 +52375,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -46942,9 +52383,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -46958,12 +52406,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } } }, @@ -46974,23 +52422,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Memory Item", + "summary": "Patch a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -47000,7 +52448,7 @@ } }, "put": { - "operationId": "updateEntity@MemoryItems", + "operationId": "updateEntity@UserDataFilters", "parameters": [ { "in": "path", @@ -47020,7 +52468,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { @@ -47029,7 +52477,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -47037,9 +52485,16 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "users", + "userGroups", + "facts", + "attributes", + "labels", + "metrics", + "datasets", + "parameters", + "user", + "userGroup", "ALL" ], "type": "string" @@ -47053,12 +52508,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } } }, @@ -47069,23 +52524,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Memory Item", + "summary": "Put a User Data Filter", "tags": [ - "AI", + "Data Filters", "entities", - "memory-item-controller" + "user-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -47095,9 +52550,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { "get": { - "operationId": "getAllEntities@Metrics", + "operationId": "getAllEntities@VisualizationObjects", "parameters": [ { "in": "path", @@ -47133,7 +52588,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -47146,8 +52601,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -47206,23 +52661,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Metrics", + "summary": "Get all Visualization Objects", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47232,7 +52687,7 @@ } }, "post": { - "operationId": "createEntity@Metrics", + "operationId": "createEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -47244,7 +52699,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -47257,8 +52712,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -47297,12 +52752,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } } }, @@ -47313,35 +52768,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Metrics", + "summary": "Post Visualization Objects", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { "post": { - "operationId": "searchEntities@Metrics", + "operationId": "searchEntities@VisualizationObjects", "parameters": [ { "in": "path", @@ -47392,12 +52847,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, @@ -47406,9 +52861,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47418,9 +52873,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -47444,21 +52899,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -47487,7 +52942,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -47500,8 +52955,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -47550,23 +53005,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47576,7 +53031,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -47605,7 +53060,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -47618,8 +53073,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -47636,12 +53091,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } } }, @@ -47652,33 +53107,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@VisualizationObjects", "parameters": [ { "in": "path", @@ -47707,7 +53162,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", @@ -47720,8 +53175,8 @@ "attributes", "labels", "metrics", - "datasets", "parameters", + "datasets", "createdBy", "modifiedBy", "certifiedBy", @@ -47738,12 +53193,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } } }, @@ -47754,35 +53209,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Visualization Object", "tags": [ - "Metrics", + "Visualization Object", "entities", - "metric-controller" + "visualization-object-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes": { "get": { - "operationId": "getAllEntities@Parameters", + "operationId": "getAllEntities@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -47809,34 +53264,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -47884,23 +53318,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Parameters", + "summary": "Get all Workspace Color Palettes", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" + "workspace-color-palette-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47910,7 +53344,7 @@ } }, "post": { - "operationId": "createEntity@Parameters", + "operationId": "createEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -47920,27 +53354,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -47968,12 +53381,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } } }, @@ -47984,114 +53397,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Parameters", - "tags": [ - "Parameters", - "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { - "post": { - "operationId": "searchEntities@Parameters", - "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/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "workspace-color-palette-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}": { "delete": { - "operationId": "deleteEntity@Parameters", + "operationId": "deleteEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -48115,21 +53443,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Parameter", + "summary": "Delete a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] }, "get": { - "operationId": "getEntity@Parameters", + "operationId": "getEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -48149,34 +53471,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -48214,23 +53515,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Parameter", + "summary": "Get a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" + "workspace-color-palette-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48240,7 +53541,7 @@ } }, "patch": { - "operationId": "patchEntity@Parameters", + "operationId": "patchEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -48260,45 +53561,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatchDocument" } } }, @@ -48309,33 +53589,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Parameter", + "summary": "Patch a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] }, "put": { - "operationId": "updateEntity@Parameters", + "operationId": "updateEntity@WorkspaceColorPalettes", "parameters": [ { "in": "path", @@ -48355,45 +53629,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteInDocument" } } }, @@ -48404,35 +53657,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Parameter", + "summary": "Put a Workspace Color Palette", "tags": [ - "Parameters", + "Appearance", "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-color-palette-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { "get": { - "operationId": "getAllEntities@UserDataFilters", + "operationId": "getAllEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48459,7 +53706,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -48468,7 +53715,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -48476,16 +53723,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -48541,23 +53780,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all User Data Filters", + "summary": "Get all Settings for Workspace Data Filters", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48567,7 +53806,7 @@ } }, "post": { - "operationId": "createEntity@UserDataFilters", + "operationId": "createEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48579,7 +53818,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -48587,16 +53826,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -48632,12 +53863,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, @@ -48648,35 +53879,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post User Data Filters", + "summary": "Post Settings for Workspace Data Filters", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { "post": { - "operationId": "searchEntities@UserDataFilters", + "operationId": "searchEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48727,12 +53958,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, @@ -48743,7 +53974,7 @@ "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48753,9 +53984,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@UserDataFilters", + "operationId": "deleteEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48779,21 +54010,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a User Data Filter", + "summary": "Delete a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "get": { - "operationId": "getEntity@UserDataFilters", + "operationId": "getEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48813,7 +54044,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -48822,7 +54053,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -48830,16 +54061,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -48885,23 +54108,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a User Data Filter", + "summary": "Get a Setting for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48911,7 +54134,7 @@ } }, "patch": { - "operationId": "patchEntity@UserDataFilters", + "operationId": "patchEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -48931,7 +54154,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -48940,7 +54163,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -48948,16 +54171,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -48971,12 +54186,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } } }, @@ -48987,33 +54202,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a User Data Filter", + "summary": "Patch a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "put": { - "operationId": "updateEntity@UserDataFilters", + "operationId": "updateEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", @@ -49033,7 +54248,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", + "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { @@ -49042,7 +54257,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", @@ -49050,16 +54265,8 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", - "user", - "userGroup", + "workspaceDataFilters", + "workspaceDataFilter", "ALL" ], "type": "string" @@ -49073,12 +54280,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, @@ -49089,35 +54296,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a User Data Filter", + "summary": "Put a Settings for Workspace Data Filter", "tags": [ "Data Filters", "entities", - "user-data-filter-controller" + "workspace-data-filter-setting-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { "get": { - "operationId": "getAllEntities@VisualizationObjects", + "operationId": "getAllEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49144,7 +54351,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -49153,7 +54360,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -49161,16 +54368,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -49226,23 +54425,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Visualization Objects", + "summary": "Get all Workspace Data Filters", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49252,7 +54451,7 @@ } }, "post": { - "operationId": "createEntity@VisualizationObjects", + "operationId": "createEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49264,7 +54463,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -49272,16 +54471,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -49317,12 +54508,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, @@ -49333,35 +54524,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Visualization Objects", + "summary": "Post Workspace Data Filters", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { "post": { - "operationId": "searchEntities@VisualizationObjects", + "operationId": "searchEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49412,12 +54603,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, @@ -49426,9 +54617,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49438,9 +54629,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { "delete": { - "operationId": "deleteEntity@VisualizationObjects", + "operationId": "deleteEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49464,21 +54655,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Visualization Object", + "summary": "Delete a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@VisualizationObjects", + "operationId": "getEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49498,7 +54689,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -49507,7 +54698,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -49515,16 +54706,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -49570,23 +54753,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Visualization Object", + "summary": "Get a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49596,7 +54779,7 @@ } }, "patch": { - "operationId": "patchEntity@VisualizationObjects", + "operationId": "patchEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49616,7 +54799,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -49625,7 +54808,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -49633,16 +54816,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -49656,12 +54831,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } } }, @@ -49672,33 +54847,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Visualization Object", + "summary": "Patch a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@VisualizationObjects", + "operationId": "updateEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", @@ -49718,7 +54893,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -49727,7 +54902,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "filterSettings", "explode": false, "in": "query", "name": "include", @@ -49735,16 +54910,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "parameters", - "datasets", - "createdBy", - "modifiedBy", - "certifiedBy", + "workspaceDataFilterSettings", + "filterSettings", "ALL" ], "type": "string" @@ -49758,12 +54925,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, @@ -49774,35 +54941,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Visualization Object", + "summary": "Put a Workspace Data Filter", "tags": [ - "Visualization Object", + "Data Filters", "entities", - "visualization-object-controller" + "workspace-data-filter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates": { "get": { - "operationId": "getAllEntities@WorkspaceDataFilterSettings", + "operationId": "getAllEntities@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -49829,33 +54996,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -49903,23 +55050,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Settings for Workspace Data Filters", + "summary": "Get all Workspace Export Templates", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" + "workspace-export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49929,7 +55076,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceDataFilterSettings", + "operationId": "createEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -49939,26 +55086,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -49986,12 +55113,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalIdDocument" } } }, @@ -50002,114 +55129,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Settings for Workspace Data Filters", + "summary": "Post Workspace Export Template", "tags": [ - "Data Filters", - "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceDataFilterSettings", - "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/JsonApiWorkspaceDataFilterSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "workspace-export-template-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceDataFilterSettings", + "operationId": "deleteEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -50133,21 +55175,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Settings for Workspace Data Filter", + "summary": "Delete a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] }, "get": { - "operationId": "getEntity@WorkspaceDataFilterSettings", + "operationId": "getEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -50167,33 +55203,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -50231,23 +55247,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Setting for Workspace Data Filter", + "summary": "Get a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" + "workspace-export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50257,7 +55273,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceDataFilterSettings", + "operationId": "patchEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -50277,44 +55293,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatchDocument" } } }, @@ -50325,33 +55321,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Settings for Workspace Data Filter", + "summary": "Patch a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] }, "put": { - "operationId": "updateEntity@WorkspaceDataFilterSettings", + "operationId": "updateEntity@WorkspaceExportTemplates", "parameters": [ { "in": "path", @@ -50371,44 +55361,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", + "example": "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateInDocument" } } }, @@ -50419,35 +55389,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Settings for Workspace Data Filter", + "summary": "Put a Workspace Export Template", "tags": [ - "Data Filters", + "Export templates", "entities", - "workspace-data-filter-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", - "permissions": [ - "MANAGE" - ] - } + "workspace-export-template-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { "get": { - "operationId": "getAllEntities@WorkspaceDataFilters", + "operationId": "getAllEntities@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50474,33 +55438,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -50548,23 +55492,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Workspace Data Filters", + "summary": "Get all Setting for Workspaces", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50574,7 +55518,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceDataFilters", + "operationId": "createEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50584,26 +55528,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -50631,12 +55555,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } } }, @@ -50647,35 +55571,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace Data Filters", + "summary": "Post Settings for Workspaces", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { "post": { - "operationId": "searchEntities@WorkspaceDataFilters", + "operationId": "searchEntities@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50726,12 +55644,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, @@ -50740,9 +55658,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50752,9 +55670,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceDataFilters", + "operationId": "deleteEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50778,21 +55696,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Workspace Data Filter", + "summary": "Delete a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] }, "get": { - "operationId": "getEntity@WorkspaceDataFilters", + "operationId": "getEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50812,33 +55724,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -50876,23 +55768,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Workspace Data Filter", + "summary": "Get a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" + "workspace-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50902,7 +55794,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceDataFilters", + "operationId": "patchEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -50922,44 +55814,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } } }, @@ -50970,33 +55842,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Workspace Data Filter", + "summary": "Patch a Setting for Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] }, "put": { - "operationId": "updateEntity@WorkspaceDataFilters", + "operationId": "updateEntity@WorkspaceSettings", "parameters": [ { "in": "path", @@ -51016,44 +55882,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } } }, @@ -51064,35 +55910,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Workspace Data Filter", + "summary": "Put a Setting for a Workspace", "tags": [ - "Data Filters", + "Workspaces - Settings", "entities", - "workspace-data-filter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "workspace-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceThemes": { "get": { - "operationId": "getAllEntities@WorkspaceSettings", + "operationId": "getAllEntities@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51119,7 +55959,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51173,23 +56013,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Setting for Workspaces", + "summary": "Get all Workspace Themes", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51199,7 +56039,7 @@ } }, "post": { - "operationId": "createEntity@WorkspaceSettings", + "operationId": "createEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51236,12 +56076,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } } }, @@ -51252,108 +56092,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Settings for Workspaces", + "summary": "Post Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceSettings", - "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/JsonApiWorkspaceSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/workspaceThemes/{objectId}": { "delete": { - "operationId": "deleteEntity@WorkspaceSettings", + "operationId": "deleteEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51377,15 +56138,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Setting for Workspace", + "summary": "Delete a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] }, "get": { - "operationId": "getEntity@WorkspaceSettings", + "operationId": "getEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51405,7 +56166,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51449,23 +56210,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Setting for Workspace", + "summary": "Get a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51475,7 +56236,7 @@ } }, "patch": { - "operationId": "patchEntity@WorkspaceSettings", + "operationId": "patchEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51495,7 +56256,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51507,12 +56268,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatchDocument" } } }, @@ -51523,27 +56284,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Setting for Workspace", + "summary": "Patch a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] }, "put": { - "operationId": "updateEntity@WorkspaceSettings", + "operationId": "updateEntity@WorkspaceThemes", "parameters": [ { "in": "path", @@ -51563,7 +56324,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51575,12 +56336,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeInDocument" } } }, @@ -51591,23 +56352,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Setting for a Workspace", + "summary": "Put a Workspace Theme", "tags": [ - "Workspaces - Settings", + "Appearance", "entities", - "workspace-setting-controller" + "workspace-theme-controller" ] } }, @@ -51654,6 +56415,7 @@ }, "responses": { "204": { + "content": {}, "description": "All AI agent configurations set." } }, @@ -51713,6 +56475,7 @@ }, "responses": { "204": { + "content": {}, "description": "All custom geo collections set." } }, @@ -51772,6 +56535,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all data sources." } }, @@ -51851,6 +56615,7 @@ }, "responses": { "204": { + "content": {}, "description": "No Content" } }, @@ -51883,6 +56648,7 @@ ], "responses": { "204": { + "content": {}, "description": "Statistics deleted." } }, @@ -51976,6 +56742,7 @@ }, "responses": { "204": { + "content": {}, "description": "Statistics stored successfully." } }, @@ -52035,6 +56802,7 @@ }, "responses": { "204": { + "content": {}, "description": "All export templates set." } }, @@ -52100,6 +56868,7 @@ }, "responses": { "204": { + "content": {}, "description": "All identity providers set." } }, @@ -52159,6 +56928,7 @@ }, "responses": { "204": { + "content": {}, "description": "All notification channels set." } }, @@ -52235,6 +57005,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all parts of an organization." } }, @@ -52301,6 +57072,7 @@ }, "responses": { "204": { + "content": {}, "description": "Organization permissions set." } }, @@ -52360,6 +57132,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all user groups." } }, @@ -52439,6 +57212,7 @@ }, "responses": { "204": { + "content": {}, "description": "User-group permissions successfully set." } }, @@ -52498,6 +57272,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all users." } }, @@ -52577,6 +57352,7 @@ }, "responses": { "204": { + "content": {}, "description": "User permissions successfully set." } }, @@ -52636,6 +57412,7 @@ }, "responses": { "204": { + "content": {}, "description": "Defined all users and user groups." } }, @@ -52695,6 +57472,7 @@ }, "responses": { "204": { + "content": {}, "description": "All workspace data filters set." } }, @@ -52771,6 +57549,7 @@ }, "responses": { "204": { + "content": {}, "description": "All workspaces layout set." } }, @@ -52865,6 +57644,7 @@ }, "responses": { "204": { + "content": {}, "description": "The model of the workspace was set." } }, @@ -52959,6 +57739,7 @@ }, "responses": { "204": { + "content": {}, "description": "Analytics model successfully set." } }, @@ -53059,6 +57840,7 @@ }, "responses": { "204": { + "content": {}, "description": "Automations successfully set." } }, @@ -53159,6 +57941,7 @@ }, "responses": { "204": { + "content": {}, "description": "FilterViews successfully set." } }, @@ -53246,6 +58029,7 @@ }, "responses": { "204": { + "content": {}, "description": "Logical model successfully set." } }, @@ -53325,6 +58109,7 @@ }, "responses": { "204": { + "content": {}, "description": "Workspace permissions successfully set." } }, @@ -53404,6 +58189,7 @@ }, "responses": { "204": { + "content": {}, "description": "User data filters successfully set." } }, diff --git a/schemas/gooddata-result-client.json b/schemas/gooddata-result-client.json index ccd00aca5..9b77543e6 100644 --- a/schemas/gooddata-result-client.json +++ b/schemas/gooddata-result-client.json @@ -191,6 +191,7 @@ "properties": { "location": { "description": "Location of the file in the staging area to convert.", + "minLength": 1, "type": "string" } }, @@ -1068,6 +1069,7 @@ }, "responses": { "204": { + "content": {}, "description": "Successful deletion." } }, @@ -1383,6 +1385,7 @@ "description": "Features retrieved successfully" }, "404": { + "content": {}, "description": "Collection not found" } }, @@ -1461,6 +1464,7 @@ "description": "Features retrieved successfully" }, "404": { + "content": {}, "description": "Collection not found" } }, diff --git a/schemas/gooddata-scan-client.json b/schemas/gooddata-scan-client.json index ced24508d..46a0e9bcc 100644 --- a/schemas/gooddata-scan-client.json +++ b/schemas/gooddata-scan-client.json @@ -712,6 +712,18 @@ "TestDefinitionRequest": { "description": "A request containing all information for testing data source definition.", "properties": { + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string" @@ -823,6 +835,18 @@ "TestRequest": { "description": "A request containing all information for testing existing data source.", "properties": { + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" + }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string"