diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 9edad2f7b..ea05ce376 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -9,6 +9,8 @@ docs/AbsoluteDateFilter.md docs/AbsoluteDateFilterAbsoluteDateFilter.md docs/AbsoluteGranularityDateFilter.md docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md +docs/AbsolutePublisherDocumentPeriod.md +docs/AbsolutePublisherDocumentPeriodAllOf.md docs/AbstractMeasureValueFilter.md docs/ActionsApi.md docs/AdHocAutomation.md @@ -59,6 +61,12 @@ docs/AnalyzeCsvRequestItemConfig.md docs/AnalyzeCsvResponse.md docs/AnalyzeCsvResponseColumn.md docs/AnalyzeCsvResponseConfig.md +docs/AnalyzeSavRequest.md +docs/AnalyzeSavRequestItem.md +docs/AnalyzeSavRequestItemConfig.md +docs/AnalyzeSavResponse.md +docs/AnalyzeSavResponseColumn.md +docs/AnalyzeSavResponseValueLabel.md docs/AnalyzeStatisticsRequest.md docs/AnomalyDetection.md docs/AnomalyDetectionRequest.md @@ -313,6 +321,10 @@ docs/DeclarativeLabelTranslation.md docs/DeclarativeLdm.md docs/DeclarativeMemoryItem.md docs/DeclarativeMetric.md +docs/DeclarativeMetricPermissionAssignment.md +docs/DeclarativeMetricPermissionForAssignee.md +docs/DeclarativeMetricPermissionForAssigneeRule.md +docs/DeclarativeMetricPermissionsInner.md docs/DeclarativeModel.md docs/DeclarativeNotificationChannel.md docs/DeclarativeNotificationChannelIdentifier.md @@ -321,6 +333,9 @@ docs/DeclarativeOrganization.md docs/DeclarativeOrganizationInfo.md docs/DeclarativeOrganizationPermission.md docs/DeclarativeParameter.md +docs/DeclarativePublisherDocument.md +docs/DeclarativePublisherDocumentPageTemplate.md +docs/DeclarativePublisherDocumentTemplate.md docs/DeclarativeReference.md docs/DeclarativeReferenceSource.md docs/DeclarativeReport.md @@ -347,6 +362,10 @@ docs/DeclarativeUserPermissions.md docs/DeclarativeUsers.md docs/DeclarativeUsersUserGroups.md docs/DeclarativeVisualizationObject.md +docs/DeclarativeVisualizationObjectPermissionAssignment.md +docs/DeclarativeVisualizationObjectPermissionForAssignee.md +docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md +docs/DeclarativeVisualizationObjectPermissionsInner.md docs/DeclarativeWorkspace.md docs/DeclarativeWorkspaceColorPalette.md docs/DeclarativeWorkspaceDataFilter.md @@ -377,6 +396,8 @@ docs/DependsOnMatchFilter.md docs/DependsOnMatchFilterAllOf.md docs/Dimension.md docs/DimensionHeader.md +docs/DocumentControllerApi.md +docs/DocumentTemplateControllerApi.md docs/Element.md docs/ElementsRequest.md docs/ElementsRequestDependsOnInner.md @@ -462,7 +483,7 @@ docs/GeoJsonFeatureCollection.md docs/GeoJsonGeometry.md docs/GeographicDataApi.md docs/GetAiLakeOperation200Response.md -docs/GetImageExport202ResponseInner.md +docs/GetDocumentExport202ResponseInner.md docs/GetQualityIssuesResponse.md docs/GetServiceStatusResponse.md docs/GrainIdentifier.md @@ -488,6 +509,10 @@ docs/ImportCsvRequestTableSourceConfig.md docs/ImportCsvResponse.md docs/ImportGeoCollectionRequest.md docs/ImportGeoCollectionResponse.md +docs/ImportSavRequest.md +docs/ImportSavRequestTable.md +docs/ImportSavRequestTableSource.md +docs/ImportSavResponse.md docs/InPlatform.md docs/InPlatformAllOf.md docs/IndefiniteCacheRetention.md @@ -1044,6 +1069,49 @@ docs/JsonApiParameterPatchDocument.md docs/JsonApiParameterPostOptionalId.md docs/JsonApiParameterPostOptionalIdDocument.md docs/JsonApiParameterToManyLinkage.md +docs/JsonApiPublisherDocumentIn.md +docs/JsonApiPublisherDocumentInAttributes.md +docs/JsonApiPublisherDocumentInAttributesContent.md +docs/JsonApiPublisherDocumentInAttributesPeriod.md +docs/JsonApiPublisherDocumentInDocument.md +docs/JsonApiPublisherDocumentOut.md +docs/JsonApiPublisherDocumentOutAttributes.md +docs/JsonApiPublisherDocumentOutDocument.md +docs/JsonApiPublisherDocumentOutList.md +docs/JsonApiPublisherDocumentOutWithLinks.md +docs/JsonApiPublisherDocumentPageTemplateIn.md +docs/JsonApiPublisherDocumentPageTemplateInAttributes.md +docs/JsonApiPublisherDocumentPageTemplateInAttributesContent.md +docs/JsonApiPublisherDocumentPageTemplateInDocument.md +docs/JsonApiPublisherDocumentPageTemplateOut.md +docs/JsonApiPublisherDocumentPageTemplateOutAttributes.md +docs/JsonApiPublisherDocumentPageTemplateOutDocument.md +docs/JsonApiPublisherDocumentPageTemplateOutList.md +docs/JsonApiPublisherDocumentPageTemplateOutWithLinks.md +docs/JsonApiPublisherDocumentPageTemplatePatch.md +docs/JsonApiPublisherDocumentPageTemplatePatchAttributes.md +docs/JsonApiPublisherDocumentPageTemplatePatchDocument.md +docs/JsonApiPublisherDocumentPageTemplatePostOptionalId.md +docs/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.md +docs/JsonApiPublisherDocumentPatch.md +docs/JsonApiPublisherDocumentPatchAttributes.md +docs/JsonApiPublisherDocumentPatchDocument.md +docs/JsonApiPublisherDocumentPostOptionalId.md +docs/JsonApiPublisherDocumentPostOptionalIdDocument.md +docs/JsonApiPublisherDocumentTemplateIn.md +docs/JsonApiPublisherDocumentTemplateInAttributes.md +docs/JsonApiPublisherDocumentTemplateInAttributesContent.md +docs/JsonApiPublisherDocumentTemplateInDocument.md +docs/JsonApiPublisherDocumentTemplateOut.md +docs/JsonApiPublisherDocumentTemplateOutAttributes.md +docs/JsonApiPublisherDocumentTemplateOutDocument.md +docs/JsonApiPublisherDocumentTemplateOutList.md +docs/JsonApiPublisherDocumentTemplateOutWithLinks.md +docs/JsonApiPublisherDocumentTemplatePatch.md +docs/JsonApiPublisherDocumentTemplatePatchAttributes.md +docs/JsonApiPublisherDocumentTemplatePatchDocument.md +docs/JsonApiPublisherDocumentTemplatePostOptionalId.md +docs/JsonApiPublisherDocumentTemplatePostOptionalIdDocument.md docs/JsonApiReportIn.md docs/JsonApiReportInAttributes.md docs/JsonApiReportInDocument.md @@ -1285,6 +1353,28 @@ docs/LlmProviderConfig.md docs/LlmProviderControllerApi.md docs/LocalIdentifier.md docs/LocaleRequest.md +docs/LocalizationApi.md +docs/LocalizationContent.md +docs/LocalizationCount.md +docs/LocalizationDataStatistics.md +docs/LocalizationDefault.md +docs/LocalizationDefaults.md +docs/LocalizationMetadataStatistics.md +docs/LocalizationResolvedValue.md +docs/LocalizationResolvedValues.md +docs/LocalizationSettingUsage.md +docs/LocalizationSettingUsages.md +docs/LocalizationSourceCounts.md +docs/LocalizationStatistics.md +docs/LocalizationStatisticsLocale.md +docs/LocalizationUsage.md +docs/LocalizationUsageUser.md +docs/LocalizationUsageUsers.md +docs/LocalizationUsageValue.md +docs/LocalizationUsageWorkspace.md +docs/LocalizationUsageWorkspaces.md +docs/LocalizationUserValue.md +docs/LocalizationUserValues.md docs/ManageAttributePermissionsRequestInner.md docs/ManageComputedAttributePermissionsRequestInner.md docs/ManageDashboardPermissionsRequestInner.md @@ -1367,6 +1457,7 @@ docs/OutlierDetectionResponse.md docs/OutlierDetectionResult.md docs/Over.md docs/PageMetadata.md +docs/PageTemplateControllerApi.md docs/Paging.md docs/Parameter.md docs/ParameterControllerApi.md @@ -1399,6 +1490,78 @@ docs/Profile.md docs/ProfileFeatures.md docs/ProfileLinks.md docs/ProvisionDatabaseInstanceRequest.md +docs/PublisherDocumentArbitraryAttributeFilter.md +docs/PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md +docs/PublisherDocumentAreaStyle.md +docs/PublisherDocumentAreaStyleGap.md +docs/PublisherDocumentAttributeElements.md +docs/PublisherDocumentAttributeElementsByUri.md +docs/PublisherDocumentAttributeElementsByValue.md +docs/PublisherDocumentAttributeFilter.md +docs/PublisherDocumentAttributeFilterAttributeFilter.md +docs/PublisherDocumentAttributeFilterByDate.md +docs/PublisherDocumentAttributeFilterConfig.md +docs/PublisherDocumentAttributeFilterParent.md +docs/PublisherDocumentAttributeFilterParentOver.md +docs/PublisherDocumentAttributeFilterReference.md +docs/PublisherDocumentAutoVisibility.md +docs/PublisherDocumentAutoVisibilityVisible.md +docs/PublisherDocumentAxisDisplay.md +docs/PublisherDocumentAxisNameDisplay.md +docs/PublisherDocumentAxisValuesDisplay.md +docs/PublisherDocumentBoundedFilter.md +docs/PublisherDocumentChartStyle.md +docs/PublisherDocumentColumn.md +docs/PublisherDocumentComparisonCondition.md +docs/PublisherDocumentContainerStyle.md +docs/PublisherDocumentContainerStyleBorderBottomLeftRadius.md +docs/PublisherDocumentContainerStylePadding.md +docs/PublisherDocumentContent.md +docs/PublisherDocumentDataSetRef.md +docs/PublisherDocumentDateFilter.md +docs/PublisherDocumentDateFilterDateFilter.md +docs/PublisherDocumentDateFilterDateFilterFrom.md +docs/PublisherDocumentDateFilterReference.md +docs/PublisherDocumentDefaults.md +docs/PublisherDocumentFilter.md +docs/PublisherDocumentFilterReference.md +docs/PublisherDocumentHeadingWidget.md +docs/PublisherDocumentHeadlineStyle.md +docs/PublisherDocumentImageWidget.md +docs/PublisherDocumentImageWidgetStyle.md +docs/PublisherDocumentLayoutNode.md +docs/PublisherDocumentLegendDisplay.md +docs/PublisherDocumentMatchAttributeFilter.md +docs/PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md +docs/PublisherDocumentMeasureValueCondition.md +docs/PublisherDocumentMeasureValueFilter.md +docs/PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.md +docs/PublisherDocumentMeasureValueFilterReference.md +docs/PublisherDocumentObjRef.md +docs/PublisherDocumentPage.md +docs/PublisherDocumentPageStyle.md +docs/PublisherDocumentPageTemplateContent.md +docs/PublisherDocumentPeriod.md +docs/PublisherDocumentRangeCondition.md +docs/PublisherDocumentRow.md +docs/PublisherDocumentSection.md +docs/PublisherDocumentTableStyle.md +docs/PublisherDocumentTakeawayContext.md +docs/PublisherDocumentTakeawayDefaults.md +docs/PublisherDocumentTakeawayGeneration.md +docs/PublisherDocumentTakeawayWidget.md +docs/PublisherDocumentTextStyle.md +docs/PublisherDocumentTextWidget.md +docs/PublisherDocumentTextWidgetStyle.md +docs/PublisherDocumentTitleWidget.md +docs/PublisherDocumentVisibility.md +docs/PublisherDocumentVisualizationDisplay.md +docs/PublisherDocumentVisualizationRef.md +docs/PublisherDocumentVisualizationStyle.md +docs/PublisherDocumentVisualizationWidget.md +docs/PublisherDocumentWidgetPlaceholder.md +docs/PublisherDocumentWidgetTitle.md +docs/PublisherDocumentsApi.md docs/QualityIssue.md docs/QualityIssueObject.md docs/QualityIssuesCalculationStatusResponse.md @@ -1425,6 +1588,8 @@ docs/Relative.md docs/RelativeBoundedDateFilter.md docs/RelativeDateFilter.md docs/RelativeDateFilterRelativeDateFilter.md +docs/RelativePublisherDocumentPeriod.md +docs/RelativePublisherDocumentPeriodAllOf.md docs/RelativeWrapper.md docs/RemoveDatabaseDataSourceResponse.md docs/ReportControllerApi.md @@ -1587,6 +1752,7 @@ docs/WorkspaceDataFilterSettingControllerApi.md docs/WorkspaceDataSource.md docs/WorkspaceExportTemplateControllerApi.md docs/WorkspaceIdentifier.md +docs/WorkspaceLocalizationUsage.md docs/WorkspacePermissionAssignment.md docs/WorkspaceSettingControllerApi.md docs/WorkspaceThemeControllerApi.md @@ -1653,6 +1819,8 @@ gooddata_api_client/api/data_source_statistics_api.py gooddata_api_client/api/dataset_controller_api.py gooddata_api_client/api/datasets_api.py gooddata_api_client/api/dependency_graph_api.py +gooddata_api_client/api/document_controller_api.py +gooddata_api_client/api/document_template_controller_api.py gooddata_api_client/api/entities_api.py gooddata_api_client/api/entitlement_api.py gooddata_api_client/api/entitlement_entity_controller_api.py @@ -1688,6 +1856,7 @@ gooddata_api_client/api/ldm_declarative_apis_api.py gooddata_api_client/api/llm_endpoints_api.py gooddata_api_client/api/llm_provider_controller_api.py gooddata_api_client/api/llm_providers_api.py +gooddata_api_client/api/localization_api.py gooddata_api_client/api/manage_permissions_api.py gooddata_api_client/api/memory_item_controller_api.py gooddata_api_client/api/memory_items_api.py @@ -1705,10 +1874,12 @@ 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 gooddata_api_client/api/organization_setting_controller_api.py +gooddata_api_client/api/page_template_controller_api.py gooddata_api_client/api/parameter_controller_api.py gooddata_api_client/api/parameters_api.py gooddata_api_client/api/permissions_api.py gooddata_api_client/api/plugins_api.py +gooddata_api_client/api/publisher_documents_api.py gooddata_api_client/api/raw_export_api.py gooddata_api_client/api/report_controller_api.py gooddata_api_client/api/report_export_api.py @@ -1760,6 +1931,8 @@ 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/absolute_publisher_document_period.py +gooddata_api_client/model/absolute_publisher_document_period_all_of.py gooddata_api_client/model/abstract_measure_value_filter.py gooddata_api_client/model/ad_hoc_automation.py gooddata_api_client/model/add_database_data_source_request.py @@ -1805,6 +1978,12 @@ gooddata_api_client/model/analyze_csv_request_item_config.py gooddata_api_client/model/analyze_csv_response.py gooddata_api_client/model/analyze_csv_response_column.py gooddata_api_client/model/analyze_csv_response_config.py +gooddata_api_client/model/analyze_sav_request.py +gooddata_api_client/model/analyze_sav_request_item.py +gooddata_api_client/model/analyze_sav_request_item_config.py +gooddata_api_client/model/analyze_sav_response.py +gooddata_api_client/model/analyze_sav_response_column.py +gooddata_api_client/model/analyze_sav_response_value_label.py gooddata_api_client/model/analyze_statistics_request.py gooddata_api_client/model/anomaly_detection.py gooddata_api_client/model/anomaly_detection_request.py @@ -2018,6 +2197,10 @@ gooddata_api_client/model/declarative_label_translation.py gooddata_api_client/model/declarative_ldm.py gooddata_api_client/model/declarative_memory_item.py gooddata_api_client/model/declarative_metric.py +gooddata_api_client/model/declarative_metric_permission_assignment.py +gooddata_api_client/model/declarative_metric_permission_for_assignee.py +gooddata_api_client/model/declarative_metric_permission_for_assignee_rule.py +gooddata_api_client/model/declarative_metric_permissions_inner.py gooddata_api_client/model/declarative_model.py gooddata_api_client/model/declarative_notification_channel.py gooddata_api_client/model/declarative_notification_channel_identifier.py @@ -2026,6 +2209,9 @@ 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_publisher_document.py +gooddata_api_client/model/declarative_publisher_document_page_template.py +gooddata_api_client/model/declarative_publisher_document_template.py gooddata_api_client/model/declarative_reference.py gooddata_api_client/model/declarative_reference_source.py gooddata_api_client/model/declarative_report.py @@ -2052,6 +2238,10 @@ gooddata_api_client/model/declarative_user_permissions.py gooddata_api_client/model/declarative_users.py gooddata_api_client/model/declarative_users_user_groups.py gooddata_api_client/model/declarative_visualization_object.py +gooddata_api_client/model/declarative_visualization_object_permission_assignment.py +gooddata_api_client/model/declarative_visualization_object_permission_for_assignee.py +gooddata_api_client/model/declarative_visualization_object_permission_for_assignee_rule.py +gooddata_api_client/model/declarative_visualization_object_permissions_inner.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 @@ -2148,7 +2338,7 @@ gooddata_api_client/model/geo_json_feature.py gooddata_api_client/model/geo_json_feature_collection.py gooddata_api_client/model/geo_json_geometry.py gooddata_api_client/model/get_ai_lake_operation200_response.py -gooddata_api_client/model/get_image_export202_response_inner.py +gooddata_api_client/model/get_document_export202_response_inner.py gooddata_api_client/model/get_quality_issues_response.py gooddata_api_client/model/get_service_status_response.py gooddata_api_client/model/grain_identifier.py @@ -2170,6 +2360,10 @@ gooddata_api_client/model/import_csv_request_table_source_config.py gooddata_api_client/model/import_csv_response.py gooddata_api_client/model/import_geo_collection_request.py gooddata_api_client/model/import_geo_collection_response.py +gooddata_api_client/model/import_sav_request.py +gooddata_api_client/model/import_sav_request_table.py +gooddata_api_client/model/import_sav_request_table_source.py +gooddata_api_client/model/import_sav_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 @@ -2723,6 +2917,49 @@ gooddata_api_client/model/json_api_parameter_patch_document.py gooddata_api_client/model/json_api_parameter_post_optional_id.py gooddata_api_client/model/json_api_parameter_post_optional_id_document.py gooddata_api_client/model/json_api_parameter_to_many_linkage.py +gooddata_api_client/model/json_api_publisher_document_in.py +gooddata_api_client/model/json_api_publisher_document_in_attributes.py +gooddata_api_client/model/json_api_publisher_document_in_attributes_content.py +gooddata_api_client/model/json_api_publisher_document_in_attributes_period.py +gooddata_api_client/model/json_api_publisher_document_in_document.py +gooddata_api_client/model/json_api_publisher_document_out.py +gooddata_api_client/model/json_api_publisher_document_out_attributes.py +gooddata_api_client/model/json_api_publisher_document_out_document.py +gooddata_api_client/model/json_api_publisher_document_out_list.py +gooddata_api_client/model/json_api_publisher_document_out_with_links.py +gooddata_api_client/model/json_api_publisher_document_page_template_in.py +gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes.py +gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes_content.py +gooddata_api_client/model/json_api_publisher_document_page_template_in_document.py +gooddata_api_client/model/json_api_publisher_document_page_template_out.py +gooddata_api_client/model/json_api_publisher_document_page_template_out_attributes.py +gooddata_api_client/model/json_api_publisher_document_page_template_out_document.py +gooddata_api_client/model/json_api_publisher_document_page_template_out_list.py +gooddata_api_client/model/json_api_publisher_document_page_template_out_with_links.py +gooddata_api_client/model/json_api_publisher_document_page_template_patch.py +gooddata_api_client/model/json_api_publisher_document_page_template_patch_attributes.py +gooddata_api_client/model/json_api_publisher_document_page_template_patch_document.py +gooddata_api_client/model/json_api_publisher_document_page_template_post_optional_id.py +gooddata_api_client/model/json_api_publisher_document_page_template_post_optional_id_document.py +gooddata_api_client/model/json_api_publisher_document_patch.py +gooddata_api_client/model/json_api_publisher_document_patch_attributes.py +gooddata_api_client/model/json_api_publisher_document_patch_document.py +gooddata_api_client/model/json_api_publisher_document_post_optional_id.py +gooddata_api_client/model/json_api_publisher_document_post_optional_id_document.py +gooddata_api_client/model/json_api_publisher_document_template_in.py +gooddata_api_client/model/json_api_publisher_document_template_in_attributes.py +gooddata_api_client/model/json_api_publisher_document_template_in_attributes_content.py +gooddata_api_client/model/json_api_publisher_document_template_in_document.py +gooddata_api_client/model/json_api_publisher_document_template_out.py +gooddata_api_client/model/json_api_publisher_document_template_out_attributes.py +gooddata_api_client/model/json_api_publisher_document_template_out_document.py +gooddata_api_client/model/json_api_publisher_document_template_out_list.py +gooddata_api_client/model/json_api_publisher_document_template_out_with_links.py +gooddata_api_client/model/json_api_publisher_document_template_patch.py +gooddata_api_client/model/json_api_publisher_document_template_patch_attributes.py +gooddata_api_client/model/json_api_publisher_document_template_patch_document.py +gooddata_api_client/model/json_api_publisher_document_template_post_optional_id.py +gooddata_api_client/model/json_api_publisher_document_template_post_optional_id_document.py gooddata_api_client/model/json_api_report_in.py gooddata_api_client/model/json_api_report_in_attributes.py gooddata_api_client/model/json_api_report_in_document.py @@ -2954,6 +3191,27 @@ gooddata_api_client/model/llm_model.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/localization_content.py +gooddata_api_client/model/localization_count.py +gooddata_api_client/model/localization_data_statistics.py +gooddata_api_client/model/localization_default.py +gooddata_api_client/model/localization_defaults.py +gooddata_api_client/model/localization_metadata_statistics.py +gooddata_api_client/model/localization_resolved_value.py +gooddata_api_client/model/localization_resolved_values.py +gooddata_api_client/model/localization_setting_usage.py +gooddata_api_client/model/localization_setting_usages.py +gooddata_api_client/model/localization_source_counts.py +gooddata_api_client/model/localization_statistics.py +gooddata_api_client/model/localization_statistics_locale.py +gooddata_api_client/model/localization_usage.py +gooddata_api_client/model/localization_usage_user.py +gooddata_api_client/model/localization_usage_users.py +gooddata_api_client/model/localization_usage_value.py +gooddata_api_client/model/localization_usage_workspace.py +gooddata_api_client/model/localization_usage_workspaces.py +gooddata_api_client/model/localization_user_value.py +gooddata_api_client/model/localization_user_values.py gooddata_api_client/model/manage_attribute_permissions_request_inner.py gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py gooddata_api_client/model/manage_dashboard_permissions_request_inner.py @@ -3047,6 +3305,77 @@ gooddata_api_client/model/profile.py gooddata_api_client/model/profile_features.py gooddata_api_client/model/profile_links.py gooddata_api_client/model/provision_database_instance_request.py +gooddata_api_client/model/publisher_document_arbitrary_attribute_filter.py +gooddata_api_client/model/publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter.py +gooddata_api_client/model/publisher_document_area_style.py +gooddata_api_client/model/publisher_document_area_style_gap.py +gooddata_api_client/model/publisher_document_attribute_elements.py +gooddata_api_client/model/publisher_document_attribute_elements_by_uri.py +gooddata_api_client/model/publisher_document_attribute_elements_by_value.py +gooddata_api_client/model/publisher_document_attribute_filter.py +gooddata_api_client/model/publisher_document_attribute_filter_attribute_filter.py +gooddata_api_client/model/publisher_document_attribute_filter_by_date.py +gooddata_api_client/model/publisher_document_attribute_filter_config.py +gooddata_api_client/model/publisher_document_attribute_filter_parent.py +gooddata_api_client/model/publisher_document_attribute_filter_parent_over.py +gooddata_api_client/model/publisher_document_attribute_filter_reference.py +gooddata_api_client/model/publisher_document_auto_visibility.py +gooddata_api_client/model/publisher_document_auto_visibility_visible.py +gooddata_api_client/model/publisher_document_axis_display.py +gooddata_api_client/model/publisher_document_axis_name_display.py +gooddata_api_client/model/publisher_document_axis_values_display.py +gooddata_api_client/model/publisher_document_bounded_filter.py +gooddata_api_client/model/publisher_document_chart_style.py +gooddata_api_client/model/publisher_document_column.py +gooddata_api_client/model/publisher_document_comparison_condition.py +gooddata_api_client/model/publisher_document_container_style.py +gooddata_api_client/model/publisher_document_container_style_border_bottom_left_radius.py +gooddata_api_client/model/publisher_document_container_style_padding.py +gooddata_api_client/model/publisher_document_content.py +gooddata_api_client/model/publisher_document_data_set_ref.py +gooddata_api_client/model/publisher_document_date_filter.py +gooddata_api_client/model/publisher_document_date_filter_date_filter.py +gooddata_api_client/model/publisher_document_date_filter_date_filter_from.py +gooddata_api_client/model/publisher_document_date_filter_reference.py +gooddata_api_client/model/publisher_document_defaults.py +gooddata_api_client/model/publisher_document_filter.py +gooddata_api_client/model/publisher_document_filter_reference.py +gooddata_api_client/model/publisher_document_heading_widget.py +gooddata_api_client/model/publisher_document_headline_style.py +gooddata_api_client/model/publisher_document_image_widget.py +gooddata_api_client/model/publisher_document_image_widget_style.py +gooddata_api_client/model/publisher_document_layout_node.py +gooddata_api_client/model/publisher_document_legend_display.py +gooddata_api_client/model/publisher_document_match_attribute_filter.py +gooddata_api_client/model/publisher_document_match_attribute_filter_match_attribute_filter.py +gooddata_api_client/model/publisher_document_measure_value_condition.py +gooddata_api_client/model/publisher_document_measure_value_filter.py +gooddata_api_client/model/publisher_document_measure_value_filter_dashboard_measure_value_filter.py +gooddata_api_client/model/publisher_document_measure_value_filter_reference.py +gooddata_api_client/model/publisher_document_obj_ref.py +gooddata_api_client/model/publisher_document_page.py +gooddata_api_client/model/publisher_document_page_style.py +gooddata_api_client/model/publisher_document_page_template_content.py +gooddata_api_client/model/publisher_document_period.py +gooddata_api_client/model/publisher_document_range_condition.py +gooddata_api_client/model/publisher_document_row.py +gooddata_api_client/model/publisher_document_section.py +gooddata_api_client/model/publisher_document_table_style.py +gooddata_api_client/model/publisher_document_takeaway_context.py +gooddata_api_client/model/publisher_document_takeaway_defaults.py +gooddata_api_client/model/publisher_document_takeaway_generation.py +gooddata_api_client/model/publisher_document_takeaway_widget.py +gooddata_api_client/model/publisher_document_text_style.py +gooddata_api_client/model/publisher_document_text_widget.py +gooddata_api_client/model/publisher_document_text_widget_style.py +gooddata_api_client/model/publisher_document_title_widget.py +gooddata_api_client/model/publisher_document_visibility.py +gooddata_api_client/model/publisher_document_visualization_display.py +gooddata_api_client/model/publisher_document_visualization_ref.py +gooddata_api_client/model/publisher_document_visualization_style.py +gooddata_api_client/model/publisher_document_visualization_widget.py +gooddata_api_client/model/publisher_document_widget_placeholder.py +gooddata_api_client/model/publisher_document_widget_title.py gooddata_api_client/model/quality_issue.py gooddata_api_client/model/quality_issue_object.py gooddata_api_client/model/quality_issues_calculation_status_response.py @@ -3072,6 +3401,8 @@ gooddata_api_client/model/relative.py gooddata_api_client/model/relative_bounded_date_filter.py gooddata_api_client/model/relative_date_filter.py gooddata_api_client/model/relative_date_filter_relative_date_filter.py +gooddata_api_client/model/relative_publisher_document_period.py +gooddata_api_client/model/relative_publisher_document_period_all_of.py gooddata_api_client/model/relative_wrapper.py gooddata_api_client/model/remove_database_data_source_response.py gooddata_api_client/model/report_export_request.py @@ -3198,6 +3529,7 @@ 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_localization_usage.py gooddata_api_client/model/workspace_permission_assignment.py gooddata_api_client/model/workspace_user.py gooddata_api_client/model/workspace_user_group.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 4174548d2..5e29d3b02 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -277,8 +277,10 @@ Class | Method | HTTP request | Description *DataSourceStatisticsApi* | [**put_data_source_statistics**](docs/DataSourceStatisticsApi.md#put_data_source_statistics) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Store physical table and column statistics for a data source *DataSourceStatisticsApi* | [**scan_statistics**](docs/DataSourceStatisticsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a data source *DataSourceFilesAnalysisApi* | [**analyze_csv**](docs/DataSourceFilesAnalysisApi.md#analyze_csv) | **POST** /api/v1/actions/fileStorage/staging/analyzeCsv | Analyze CSV +*DataSourceFilesAnalysisApi* | [**analyze_sav**](docs/DataSourceFilesAnalysisApi.md#analyze_sav) | **POST** /api/v1/actions/fileStorage/staging/analyzeSav | Analyze SPSS files *DataSourceFilesDeletionApi* | [**delete_files**](docs/DataSourceFilesDeletionApi.md#delete_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles | Delete datasource files *DataSourceFilesImportApi* | [**import_csv**](docs/DataSourceFilesImportApi.md#import_csv) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv | Import CSV +*DataSourceFilesImportApi* | [**import_sav**](docs/DataSourceFilesImportApi.md#import_sav) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav | Import SPSS files *DataSourceFilesListingApi* | [**list_files**](docs/DataSourceFilesListingApi.md#list_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles | List datasource files *DataSourceFilesManifestReadApi* | [**read_csv_file_manifests**](docs/DataSourceFilesManifestReadApi.md#read_csv_file_manifests) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests | Read CSV file manifests *DataSourceStagingLocationApi* | [**staging_upload**](docs/DataSourceStagingLocationApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area @@ -398,6 +400,13 @@ Class | Method | HTTP request | Description *LabelsApi* | [**get_entity_labels**](docs/LabelsApi.md#get_entity_labels) | **GET** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Get a Label *LabelsApi* | [**patch_entity_labels**](docs/LabelsApi.md#patch_entity_labels) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/labels/{objectId} | Patch a Label (beta) *LabelsApi* | [**search_entities_labels**](docs/LabelsApi.md#search_entities_labels) | **POST** /api/v1/entities/workspaces/{workspaceId}/labels/search | The search endpoint (beta) +*LocalizationApi* | [**organization_localization_statistics**](docs/LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. +*LocalizationApi* | [**organization_localization_usage**](docs/LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. +*LocalizationApi* | [**organization_localization_usage_users**](docs/LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. +*LocalizationApi* | [**organization_localization_usage_workspaces**](docs/LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. +*LocalizationApi* | [**workspace_localization_statistics**](docs/LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. +*LocalizationApi* | [**workspace_localization_usage**](docs/LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. +*LocalizationApi* | [**workspace_localization_usage_users**](docs/LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. *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. @@ -506,9 +515,30 @@ Class | Method | HTTP request | Description *PluginsApi* | [**patch_entity_dashboard_plugins**](docs/PluginsApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin *PluginsApi* | [**search_entities_dashboard_plugins**](docs/PluginsApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) *PluginsApi* | [**update_entity_dashboard_plugins**](docs/PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin +*PublisherDocumentsApi* | [**create_entity_document_templates**](docs/PublisherDocumentsApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +*PublisherDocumentsApi* | [**create_entity_documents**](docs/PublisherDocumentsApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document +*PublisherDocumentsApi* | [**create_entity_page_templates**](docs/PublisherDocumentsApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template +*PublisherDocumentsApi* | [**delete_entity_document_templates**](docs/PublisherDocumentsApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +*PublisherDocumentsApi* | [**delete_entity_documents**](docs/PublisherDocumentsApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document +*PublisherDocumentsApi* | [**delete_entity_page_templates**](docs/PublisherDocumentsApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template +*PublisherDocumentsApi* | [**get_all_entities_document_templates**](docs/PublisherDocumentsApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +*PublisherDocumentsApi* | [**get_all_entities_documents**](docs/PublisherDocumentsApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents +*PublisherDocumentsApi* | [**get_all_entities_page_templates**](docs/PublisherDocumentsApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates +*PublisherDocumentsApi* | [**get_entity_document_templates**](docs/PublisherDocumentsApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +*PublisherDocumentsApi* | [**get_entity_documents**](docs/PublisherDocumentsApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document +*PublisherDocumentsApi* | [**get_entity_page_templates**](docs/PublisherDocumentsApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template +*PublisherDocumentsApi* | [**patch_entity_document_templates**](docs/PublisherDocumentsApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +*PublisherDocumentsApi* | [**patch_entity_documents**](docs/PublisherDocumentsApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +*PublisherDocumentsApi* | [**patch_entity_page_templates**](docs/PublisherDocumentsApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +*PublisherDocumentsApi* | [**update_entity_document_templates**](docs/PublisherDocumentsApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template +*PublisherDocumentsApi* | [**update_entity_documents**](docs/PublisherDocumentsApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document +*PublisherDocumentsApi* | [**update_entity_page_templates**](docs/PublisherDocumentsApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template *RawExportApi* | [**create_raw_export**](docs/RawExportApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request *RawExportApi* | [**get_raw_export**](docs/RawExportApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +*ReportExportApi* | [**create_document_export**](docs/ReportExportApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request *ReportExportApi* | [**create_report_export**](docs/ReportExportApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request +*ReportExportApi* | [**get_document_export**](docs/ReportExportApi.md#get_document_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId} | (EXPERIMENTAL) Retrieve exported document +*ReportExportApi* | [**get_document_export_metadata**](docs/ReportExportApi.md#get_document_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata | (EXPERIMENTAL) Retrieve document export metadata *ReportExportApi* | [**get_report_export**](docs/ReportExportApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files *ReportExportApi* | [**get_report_export_metadata**](docs/ReportExportApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *ReportingSettingsApi* | [**resolve_all_settings_without_workspace**](docs/ReportingSettingsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. @@ -665,6 +695,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**ai_chat_usage**](docs/ActionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | (REMOVED) Get Chat Usage *ActionsApi* | [**all_platform_usage**](docs/ActionsApi.md#all_platform_usage) | **GET** /api/v1/actions/collectUsage | Info about the platform usage. *ActionsApi* | [**analyze_csv**](docs/ActionsApi.md#analyze_csv) | **POST** /api/v1/actions/fileStorage/staging/analyzeCsv | Analyze CSV +*ActionsApi* | [**analyze_sav**](docs/ActionsApi.md#analyze_sav) | **POST** /api/v1/actions/fileStorage/staging/analyzeSav | Analyze SPSS files *ActionsApi* | [**anomaly_detection**](docs/ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection *ActionsApi* | [**anomaly_detection_result**](docs/ActionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result *ActionsApi* | [**attribute_permissions**](docs/ActionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions @@ -687,6 +718,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**computed_attribute_permissions**](docs/ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions *ActionsApi* | [**convert_geo_file**](docs/ActionsApi.md#convert_geo_file) | **POST** /api/v1/actions/customGeoCollection/convert | Convert a geo file to GeoParquet format *ActionsApi* | [**create_dashboard_export_request**](docs/ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request +*ActionsApi* | [**create_document_export**](docs/ActionsApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request *ActionsApi* | [**create_image_export**](docs/ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request *ActionsApi* | [**create_pdf_export**](docs/ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request *ActionsApi* | [**create_raw_export**](docs/ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request @@ -710,6 +742,8 @@ Class | Method | HTTP request | Description *ActionsApi* | [**get_data_source_schemata**](docs/ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database *ActionsApi* | [**get_dependent_entities_graph**](docs/ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph *ActionsApi* | [**get_dependent_entities_graph_from_entry_points**](docs/ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points +*ActionsApi* | [**get_document_export**](docs/ActionsApi.md#get_document_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId} | (EXPERIMENTAL) Retrieve exported document +*ActionsApi* | [**get_document_export_metadata**](docs/ActionsApi.md#get_document_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata | (EXPERIMENTAL) Retrieve document export metadata *ActionsApi* | [**get_exported_file**](docs/ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files *ActionsApi* | [**get_image_export**](docs/ActionsApi.md#get_image_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId} | (EXPERIMENTAL) Retrieve exported files *ActionsApi* | [**get_image_export_metadata**](docs/ActionsApi.md#get_image_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context @@ -726,6 +760,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**get_translation_tags**](docs/ActionsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags. *ActionsApi* | [**import_csv**](docs/ActionsApi.md#import_csv) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv | Import CSV *ActionsApi* | [**import_custom_geo_collection**](docs/ActionsApi.md#import_custom_geo_collection) | **POST** /api/v1/actions/customGeoCollection/{collectionId}/import | Import custom geo collection +*ActionsApi* | [**import_sav**](docs/ActionsApi.md#import_sav) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav | Import SPSS files *ActionsApi* | [**inherited_entity_conflicts**](docs/ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. *ActionsApi* | [**inherited_entity_prefixes**](docs/ActionsApi.md#inherited_entity_prefixes) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy *ActionsApi* | [**key_driver_analysis**](docs/ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis @@ -751,6 +786,10 @@ Class | Method | HTTP request | Description *ActionsApi* | [**mark_as_read_notification_all**](docs/ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. *ActionsApi* | [**memory_created_by_users**](docs/ActionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users *ActionsApi* | [**metric_permissions**](docs/ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions +*ActionsApi* | [**organization_localization_statistics**](docs/ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. +*ActionsApi* | [**organization_localization_usage**](docs/ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. +*ActionsApi* | [**organization_localization_usage_users**](docs/ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. +*ActionsApi* | [**organization_localization_usage_workspaces**](docs/ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. *ActionsApi* | [**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. @@ -804,6 +843,9 @@ Class | Method | HTTP request | Description *ActionsApi* | [**validate_llm_endpoint**](docs/ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint (Removed) *ActionsApi* | [**validate_llm_endpoint_by_id**](docs/ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id (Removed) *ActionsApi* | [**visualization_permissions**](docs/ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions +*ActionsApi* | [**workspace_localization_statistics**](docs/ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. +*ActionsApi* | [**workspace_localization_usage**](docs/ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. +*ActionsApi* | [**workspace_localization_usage_users**](docs/ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. *ActionsApi* | [**workspace_resolve_all_settings**](docs/ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. *ActionsApi* | [**workspace_resolve_settings**](docs/ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. *AgentControllerApi* | [**create_entity_agents**](docs/AgentControllerApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities @@ -906,6 +948,18 @@ Class | Method | HTTP request | Description *DatasetControllerApi* | [**get_entity_datasets**](docs/DatasetControllerApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset *DatasetControllerApi* | [**patch_entity_datasets**](docs/DatasetControllerApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) *DatasetControllerApi* | [**search_entities_datasets**](docs/DatasetControllerApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) +*DocumentControllerApi* | [**create_entity_documents**](docs/DocumentControllerApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document +*DocumentControllerApi* | [**delete_entity_documents**](docs/DocumentControllerApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document +*DocumentControllerApi* | [**get_all_entities_documents**](docs/DocumentControllerApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents +*DocumentControllerApi* | [**get_entity_documents**](docs/DocumentControllerApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document +*DocumentControllerApi* | [**patch_entity_documents**](docs/DocumentControllerApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +*DocumentControllerApi* | [**update_entity_documents**](docs/DocumentControllerApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document +*DocumentTemplateControllerApi* | [**create_entity_document_templates**](docs/DocumentTemplateControllerApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +*DocumentTemplateControllerApi* | [**delete_entity_document_templates**](docs/DocumentTemplateControllerApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +*DocumentTemplateControllerApi* | [**get_all_entities_document_templates**](docs/DocumentTemplateControllerApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +*DocumentTemplateControllerApi* | [**get_entity_document_templates**](docs/DocumentTemplateControllerApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +*DocumentTemplateControllerApi* | [**patch_entity_document_templates**](docs/DocumentTemplateControllerApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +*DocumentTemplateControllerApi* | [**update_entity_document_templates**](docs/DocumentTemplateControllerApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template *EntitiesApi* | [**create_entity**](docs/EntitiesApi.md#create_entity) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities (Removed) *EntitiesApi* | [**create_entity_agents**](docs/EntitiesApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities *EntitiesApi* | [**create_entity_analytical_dashboards**](docs/EntitiesApi.md#create_entity_analytical_dashboards) | **POST** /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards | Post Dashboards @@ -920,6 +974,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_custom_user_application_settings**](docs/EntitiesApi.md#create_entity_custom_user_application_settings) | **POST** /api/v1/entities/users/{userId}/customUserApplicationSettings | Post a new custom application setting for the user *EntitiesApi* | [**create_entity_dashboard_plugins**](docs/EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins *EntitiesApi* | [**create_entity_data_sources**](docs/EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +*EntitiesApi* | [**create_entity_document_templates**](docs/EntitiesApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +*EntitiesApi* | [**create_entity_documents**](docs/EntitiesApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document *EntitiesApi* | [**create_entity_export_definitions**](docs/EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions *EntitiesApi* | [**create_entity_export_templates**](docs/EntitiesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities *EntitiesApi* | [**create_entity_filter_contexts**](docs/EntitiesApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context @@ -934,6 +990,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template *EntitiesApi* | [**create_entity_parameters**](docs/EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters *EntitiesApi* | [**create_entity_report_page_layouts**](docs/EntitiesApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout *EntitiesApi* | [**create_entity_report_templates**](docs/EntitiesApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template @@ -965,6 +1022,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_custom_user_application_settings**](docs/EntitiesApi.md#delete_entity_custom_user_application_settings) | **DELETE** /api/v1/entities/users/{userId}/customUserApplicationSettings/{id} | Delete a custom application setting for a user *EntitiesApi* | [**delete_entity_dashboard_plugins**](docs/EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin *EntitiesApi* | [**delete_entity_data_sources**](docs/EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +*EntitiesApi* | [**delete_entity_document_templates**](docs/EntitiesApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +*EntitiesApi* | [**delete_entity_documents**](docs/EntitiesApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document *EntitiesApi* | [**delete_entity_export_definitions**](docs/EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition *EntitiesApi* | [**delete_entity_export_templates**](docs/EntitiesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity *EntitiesApi* | [**delete_entity_filter_contexts**](docs/EntitiesApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context @@ -979,6 +1038,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template *EntitiesApi* | [**delete_entity_parameters**](docs/EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter *EntitiesApi* | [**delete_entity_report_page_layouts**](docs/EntitiesApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout *EntitiesApi* | [**delete_entity_report_templates**](docs/EntitiesApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template @@ -1015,6 +1075,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_data_source_identifiers**](docs/EntitiesApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers *EntitiesApi* | [**get_all_entities_data_sources**](docs/EntitiesApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities *EntitiesApi* | [**get_all_entities_datasets**](docs/EntitiesApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets +*EntitiesApi* | [**get_all_entities_document_templates**](docs/EntitiesApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +*EntitiesApi* | [**get_all_entities_documents**](docs/EntitiesApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents *EntitiesApi* | [**get_all_entities_entitlements**](docs/EntitiesApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements *EntitiesApi* | [**get_all_entities_export_definitions**](docs/EntitiesApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions *EntitiesApi* | [**get_all_entities_export_templates**](docs/EntitiesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities @@ -1034,6 +1096,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates *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_report_page_layouts**](docs/EntitiesApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts *EntitiesApi* | [**get_all_entities_report_templates**](docs/EntitiesApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates @@ -1073,6 +1136,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_data_source_identifiers**](docs/EntitiesApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier *EntitiesApi* | [**get_entity_data_sources**](docs/EntitiesApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity *EntitiesApi* | [**get_entity_datasets**](docs/EntitiesApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset +*EntitiesApi* | [**get_entity_document_templates**](docs/EntitiesApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +*EntitiesApi* | [**get_entity_documents**](docs/EntitiesApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document *EntitiesApi* | [**get_entity_entitlements**](docs/EntitiesApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement entity *EntitiesApi* | [**get_entity_export_definitions**](docs/EntitiesApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition *EntitiesApi* | [**get_entity_export_templates**](docs/EntitiesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity @@ -1093,6 +1158,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template *EntitiesApi* | [**get_entity_parameters**](docs/EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter *EntitiesApi* | [**get_entity_report_page_layouts**](docs/EntitiesApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout *EntitiesApi* | [**get_entity_report_templates**](docs/EntitiesApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template @@ -1127,6 +1193,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_dashboard_plugins**](docs/EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin *EntitiesApi* | [**patch_entity_data_sources**](docs/EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity *EntitiesApi* | [**patch_entity_datasets**](docs/EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +*EntitiesApi* | [**patch_entity_document_templates**](docs/EntitiesApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +*EntitiesApi* | [**patch_entity_documents**](docs/EntitiesApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document *EntitiesApi* | [**patch_entity_export_definitions**](docs/EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition *EntitiesApi* | [**patch_entity_export_templates**](docs/EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity *EntitiesApi* | [**patch_entity_facts**](docs/EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) @@ -1143,6 +1211,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template *EntitiesApi* | [**patch_entity_parameters**](docs/EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter *EntitiesApi* | [**patch_entity_report_page_layouts**](docs/EntitiesApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout *EntitiesApi* | [**patch_entity_report_templates**](docs/EntitiesApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template @@ -1197,6 +1266,8 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_custom_user_application_settings**](docs/EntitiesApi.md#update_entity_custom_user_application_settings) | **PUT** /api/v1/entities/users/{userId}/customUserApplicationSettings/{id} | Put a custom application setting for the user *EntitiesApi* | [**update_entity_dashboard_plugins**](docs/EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *EntitiesApi* | [**update_entity_data_sources**](docs/EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity +*EntitiesApi* | [**update_entity_document_templates**](docs/EntitiesApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template +*EntitiesApi* | [**update_entity_documents**](docs/EntitiesApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document *EntitiesApi* | [**update_entity_export_definitions**](docs/EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition *EntitiesApi* | [**update_entity_export_templates**](docs/EntitiesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity *EntitiesApi* | [**update_entity_filter_contexts**](docs/EntitiesApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context @@ -1212,6 +1283,7 @@ Class | Method | HTTP request | Description *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_page_templates**](docs/EntitiesApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template *EntitiesApi* | [**update_entity_parameters**](docs/EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter *EntitiesApi* | [**update_entity_report_page_layouts**](docs/EntitiesApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout *EntitiesApi* | [**update_entity_report_templates**](docs/EntitiesApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template @@ -1384,6 +1456,12 @@ Class | Method | HTTP request | Description *OrganizationSettingControllerApi* | [**get_entity_organization_settings**](docs/OrganizationSettingControllerApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization Setting entity *OrganizationSettingControllerApi* | [**patch_entity_organization_settings**](docs/OrganizationSettingControllerApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization Setting entity *OrganizationSettingControllerApi* | [**update_entity_organization_settings**](docs/OrganizationSettingControllerApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization Setting entity +*PageTemplateControllerApi* | [**create_entity_page_templates**](docs/PageTemplateControllerApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template +*PageTemplateControllerApi* | [**delete_entity_page_templates**](docs/PageTemplateControllerApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template +*PageTemplateControllerApi* | [**get_all_entities_page_templates**](docs/PageTemplateControllerApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates +*PageTemplateControllerApi* | [**get_entity_page_templates**](docs/PageTemplateControllerApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template +*PageTemplateControllerApi* | [**patch_entity_page_templates**](docs/PageTemplateControllerApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +*PageTemplateControllerApi* | [**update_entity_page_templates**](docs/PageTemplateControllerApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template *ParameterControllerApi* | [**create_entity_parameters**](docs/ParameterControllerApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters *ParameterControllerApi* | [**delete_entity_parameters**](docs/ParameterControllerApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter *ParameterControllerApi* | [**get_all_entities_parameters**](docs/ParameterControllerApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters @@ -1502,6 +1580,8 @@ Class | Method | HTTP request | Description - [AbsoluteDateFilterAbsoluteDateFilter](docs/AbsoluteDateFilterAbsoluteDateFilter.md) - [AbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilter.md) - [AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) + - [AbsolutePublisherDocumentPeriod](docs/AbsolutePublisherDocumentPeriod.md) + - [AbsolutePublisherDocumentPeriodAllOf](docs/AbsolutePublisherDocumentPeriodAllOf.md) - [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md) - [AdHocAutomation](docs/AdHocAutomation.md) - [AddDatabaseDataSourceRequest](docs/AddDatabaseDataSourceRequest.md) @@ -1546,6 +1626,12 @@ Class | Method | HTTP request | Description - [AnalyzeCsvResponse](docs/AnalyzeCsvResponse.md) - [AnalyzeCsvResponseColumn](docs/AnalyzeCsvResponseColumn.md) - [AnalyzeCsvResponseConfig](docs/AnalyzeCsvResponseConfig.md) + - [AnalyzeSavRequest](docs/AnalyzeSavRequest.md) + - [AnalyzeSavRequestItem](docs/AnalyzeSavRequestItem.md) + - [AnalyzeSavRequestItemConfig](docs/AnalyzeSavRequestItemConfig.md) + - [AnalyzeSavResponse](docs/AnalyzeSavResponse.md) + - [AnalyzeSavResponseColumn](docs/AnalyzeSavResponseColumn.md) + - [AnalyzeSavResponseValueLabel](docs/AnalyzeSavResponseValueLabel.md) - [AnalyzeStatisticsRequest](docs/AnalyzeStatisticsRequest.md) - [AnomalyDetection](docs/AnomalyDetection.md) - [AnomalyDetectionRequest](docs/AnomalyDetectionRequest.md) @@ -1759,6 +1845,10 @@ Class | Method | HTTP request | Description - [DeclarativeLdm](docs/DeclarativeLdm.md) - [DeclarativeMemoryItem](docs/DeclarativeMemoryItem.md) - [DeclarativeMetric](docs/DeclarativeMetric.md) + - [DeclarativeMetricPermissionAssignment](docs/DeclarativeMetricPermissionAssignment.md) + - [DeclarativeMetricPermissionForAssignee](docs/DeclarativeMetricPermissionForAssignee.md) + - [DeclarativeMetricPermissionForAssigneeRule](docs/DeclarativeMetricPermissionForAssigneeRule.md) + - [DeclarativeMetricPermissionsInner](docs/DeclarativeMetricPermissionsInner.md) - [DeclarativeModel](docs/DeclarativeModel.md) - [DeclarativeNotificationChannel](docs/DeclarativeNotificationChannel.md) - [DeclarativeNotificationChannelIdentifier](docs/DeclarativeNotificationChannelIdentifier.md) @@ -1767,6 +1857,9 @@ Class | Method | HTTP request | Description - [DeclarativeOrganizationInfo](docs/DeclarativeOrganizationInfo.md) - [DeclarativeOrganizationPermission](docs/DeclarativeOrganizationPermission.md) - [DeclarativeParameter](docs/DeclarativeParameter.md) + - [DeclarativePublisherDocument](docs/DeclarativePublisherDocument.md) + - [DeclarativePublisherDocumentPageTemplate](docs/DeclarativePublisherDocumentPageTemplate.md) + - [DeclarativePublisherDocumentTemplate](docs/DeclarativePublisherDocumentTemplate.md) - [DeclarativeReference](docs/DeclarativeReference.md) - [DeclarativeReferenceSource](docs/DeclarativeReferenceSource.md) - [DeclarativeReport](docs/DeclarativeReport.md) @@ -1793,6 +1886,10 @@ Class | Method | HTTP request | Description - [DeclarativeUsers](docs/DeclarativeUsers.md) - [DeclarativeUsersUserGroups](docs/DeclarativeUsersUserGroups.md) - [DeclarativeVisualizationObject](docs/DeclarativeVisualizationObject.md) + - [DeclarativeVisualizationObjectPermissionAssignment](docs/DeclarativeVisualizationObjectPermissionAssignment.md) + - [DeclarativeVisualizationObjectPermissionForAssignee](docs/DeclarativeVisualizationObjectPermissionForAssignee.md) + - [DeclarativeVisualizationObjectPermissionForAssigneeRule](docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md) + - [DeclarativeVisualizationObjectPermissionsInner](docs/DeclarativeVisualizationObjectPermissionsInner.md) - [DeclarativeWorkspace](docs/DeclarativeWorkspace.md) - [DeclarativeWorkspaceColorPalette](docs/DeclarativeWorkspaceColorPalette.md) - [DeclarativeWorkspaceDataFilter](docs/DeclarativeWorkspaceDataFilter.md) @@ -1889,7 +1986,7 @@ Class | Method | HTTP request | Description - [GeoJsonFeatureCollection](docs/GeoJsonFeatureCollection.md) - [GeoJsonGeometry](docs/GeoJsonGeometry.md) - [GetAiLakeOperation200Response](docs/GetAiLakeOperation200Response.md) - - [GetImageExport202ResponseInner](docs/GetImageExport202ResponseInner.md) + - [GetDocumentExport202ResponseInner](docs/GetDocumentExport202ResponseInner.md) - [GetQualityIssuesResponse](docs/GetQualityIssuesResponse.md) - [GetServiceStatusResponse](docs/GetServiceStatusResponse.md) - [GrainIdentifier](docs/GrainIdentifier.md) @@ -1911,6 +2008,10 @@ Class | Method | HTTP request | Description - [ImportCsvResponse](docs/ImportCsvResponse.md) - [ImportGeoCollectionRequest](docs/ImportGeoCollectionRequest.md) - [ImportGeoCollectionResponse](docs/ImportGeoCollectionResponse.md) + - [ImportSavRequest](docs/ImportSavRequest.md) + - [ImportSavRequestTable](docs/ImportSavRequestTable.md) + - [ImportSavRequestTableSource](docs/ImportSavRequestTableSource.md) + - [ImportSavResponse](docs/ImportSavResponse.md) - [InPlatform](docs/InPlatform.md) - [InPlatformAllOf](docs/InPlatformAllOf.md) - [IndefiniteCacheRetention](docs/IndefiniteCacheRetention.md) @@ -2464,6 +2565,49 @@ Class | Method | HTTP request | Description - [JsonApiParameterPostOptionalId](docs/JsonApiParameterPostOptionalId.md) - [JsonApiParameterPostOptionalIdDocument](docs/JsonApiParameterPostOptionalIdDocument.md) - [JsonApiParameterToManyLinkage](docs/JsonApiParameterToManyLinkage.md) + - [JsonApiPublisherDocumentIn](docs/JsonApiPublisherDocumentIn.md) + - [JsonApiPublisherDocumentInAttributes](docs/JsonApiPublisherDocumentInAttributes.md) + - [JsonApiPublisherDocumentInAttributesContent](docs/JsonApiPublisherDocumentInAttributesContent.md) + - [JsonApiPublisherDocumentInAttributesPeriod](docs/JsonApiPublisherDocumentInAttributesPeriod.md) + - [JsonApiPublisherDocumentInDocument](docs/JsonApiPublisherDocumentInDocument.md) + - [JsonApiPublisherDocumentOut](docs/JsonApiPublisherDocumentOut.md) + - [JsonApiPublisherDocumentOutAttributes](docs/JsonApiPublisherDocumentOutAttributes.md) + - [JsonApiPublisherDocumentOutDocument](docs/JsonApiPublisherDocumentOutDocument.md) + - [JsonApiPublisherDocumentOutList](docs/JsonApiPublisherDocumentOutList.md) + - [JsonApiPublisherDocumentOutWithLinks](docs/JsonApiPublisherDocumentOutWithLinks.md) + - [JsonApiPublisherDocumentPageTemplateIn](docs/JsonApiPublisherDocumentPageTemplateIn.md) + - [JsonApiPublisherDocumentPageTemplateInAttributes](docs/JsonApiPublisherDocumentPageTemplateInAttributes.md) + - [JsonApiPublisherDocumentPageTemplateInAttributesContent](docs/JsonApiPublisherDocumentPageTemplateInAttributesContent.md) + - [JsonApiPublisherDocumentPageTemplateInDocument](docs/JsonApiPublisherDocumentPageTemplateInDocument.md) + - [JsonApiPublisherDocumentPageTemplateOut](docs/JsonApiPublisherDocumentPageTemplateOut.md) + - [JsonApiPublisherDocumentPageTemplateOutAttributes](docs/JsonApiPublisherDocumentPageTemplateOutAttributes.md) + - [JsonApiPublisherDocumentPageTemplateOutDocument](docs/JsonApiPublisherDocumentPageTemplateOutDocument.md) + - [JsonApiPublisherDocumentPageTemplateOutList](docs/JsonApiPublisherDocumentPageTemplateOutList.md) + - [JsonApiPublisherDocumentPageTemplateOutWithLinks](docs/JsonApiPublisherDocumentPageTemplateOutWithLinks.md) + - [JsonApiPublisherDocumentPageTemplatePatch](docs/JsonApiPublisherDocumentPageTemplatePatch.md) + - [JsonApiPublisherDocumentPageTemplatePatchAttributes](docs/JsonApiPublisherDocumentPageTemplatePatchAttributes.md) + - [JsonApiPublisherDocumentPageTemplatePatchDocument](docs/JsonApiPublisherDocumentPageTemplatePatchDocument.md) + - [JsonApiPublisherDocumentPageTemplatePostOptionalId](docs/JsonApiPublisherDocumentPageTemplatePostOptionalId.md) + - [JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument](docs/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.md) + - [JsonApiPublisherDocumentPatch](docs/JsonApiPublisherDocumentPatch.md) + - [JsonApiPublisherDocumentPatchAttributes](docs/JsonApiPublisherDocumentPatchAttributes.md) + - [JsonApiPublisherDocumentPatchDocument](docs/JsonApiPublisherDocumentPatchDocument.md) + - [JsonApiPublisherDocumentPostOptionalId](docs/JsonApiPublisherDocumentPostOptionalId.md) + - [JsonApiPublisherDocumentPostOptionalIdDocument](docs/JsonApiPublisherDocumentPostOptionalIdDocument.md) + - [JsonApiPublisherDocumentTemplateIn](docs/JsonApiPublisherDocumentTemplateIn.md) + - [JsonApiPublisherDocumentTemplateInAttributes](docs/JsonApiPublisherDocumentTemplateInAttributes.md) + - [JsonApiPublisherDocumentTemplateInAttributesContent](docs/JsonApiPublisherDocumentTemplateInAttributesContent.md) + - [JsonApiPublisherDocumentTemplateInDocument](docs/JsonApiPublisherDocumentTemplateInDocument.md) + - [JsonApiPublisherDocumentTemplateOut](docs/JsonApiPublisherDocumentTemplateOut.md) + - [JsonApiPublisherDocumentTemplateOutAttributes](docs/JsonApiPublisherDocumentTemplateOutAttributes.md) + - [JsonApiPublisherDocumentTemplateOutDocument](docs/JsonApiPublisherDocumentTemplateOutDocument.md) + - [JsonApiPublisherDocumentTemplateOutList](docs/JsonApiPublisherDocumentTemplateOutList.md) + - [JsonApiPublisherDocumentTemplateOutWithLinks](docs/JsonApiPublisherDocumentTemplateOutWithLinks.md) + - [JsonApiPublisherDocumentTemplatePatch](docs/JsonApiPublisherDocumentTemplatePatch.md) + - [JsonApiPublisherDocumentTemplatePatchAttributes](docs/JsonApiPublisherDocumentTemplatePatchAttributes.md) + - [JsonApiPublisherDocumentTemplatePatchDocument](docs/JsonApiPublisherDocumentTemplatePatchDocument.md) + - [JsonApiPublisherDocumentTemplatePostOptionalId](docs/JsonApiPublisherDocumentTemplatePostOptionalId.md) + - [JsonApiPublisherDocumentTemplatePostOptionalIdDocument](docs/JsonApiPublisherDocumentTemplatePostOptionalIdDocument.md) - [JsonApiReportIn](docs/JsonApiReportIn.md) - [JsonApiReportInAttributes](docs/JsonApiReportInAttributes.md) - [JsonApiReportInDocument](docs/JsonApiReportInDocument.md) @@ -2695,6 +2839,27 @@ Class | Method | HTTP request | Description - [LlmProviderConfig](docs/LlmProviderConfig.md) - [LocalIdentifier](docs/LocalIdentifier.md) - [LocaleRequest](docs/LocaleRequest.md) + - [LocalizationContent](docs/LocalizationContent.md) + - [LocalizationCount](docs/LocalizationCount.md) + - [LocalizationDataStatistics](docs/LocalizationDataStatistics.md) + - [LocalizationDefault](docs/LocalizationDefault.md) + - [LocalizationDefaults](docs/LocalizationDefaults.md) + - [LocalizationMetadataStatistics](docs/LocalizationMetadataStatistics.md) + - [LocalizationResolvedValue](docs/LocalizationResolvedValue.md) + - [LocalizationResolvedValues](docs/LocalizationResolvedValues.md) + - [LocalizationSettingUsage](docs/LocalizationSettingUsage.md) + - [LocalizationSettingUsages](docs/LocalizationSettingUsages.md) + - [LocalizationSourceCounts](docs/LocalizationSourceCounts.md) + - [LocalizationStatistics](docs/LocalizationStatistics.md) + - [LocalizationStatisticsLocale](docs/LocalizationStatisticsLocale.md) + - [LocalizationUsage](docs/LocalizationUsage.md) + - [LocalizationUsageUser](docs/LocalizationUsageUser.md) + - [LocalizationUsageUsers](docs/LocalizationUsageUsers.md) + - [LocalizationUsageValue](docs/LocalizationUsageValue.md) + - [LocalizationUsageWorkspace](docs/LocalizationUsageWorkspace.md) + - [LocalizationUsageWorkspaces](docs/LocalizationUsageWorkspaces.md) + - [LocalizationUserValue](docs/LocalizationUserValue.md) + - [LocalizationUserValues](docs/LocalizationUserValues.md) - [ManageAttributePermissionsRequestInner](docs/ManageAttributePermissionsRequestInner.md) - [ManageComputedAttributePermissionsRequestInner](docs/ManageComputedAttributePermissionsRequestInner.md) - [ManageDashboardPermissionsRequestInner](docs/ManageDashboardPermissionsRequestInner.md) @@ -2788,6 +2953,77 @@ Class | Method | HTTP request | Description - [ProfileFeatures](docs/ProfileFeatures.md) - [ProfileLinks](docs/ProfileLinks.md) - [ProvisionDatabaseInstanceRequest](docs/ProvisionDatabaseInstanceRequest.md) + - [PublisherDocumentArbitraryAttributeFilter](docs/PublisherDocumentArbitraryAttributeFilter.md) + - [PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter](docs/PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md) + - [PublisherDocumentAreaStyle](docs/PublisherDocumentAreaStyle.md) + - [PublisherDocumentAreaStyleGap](docs/PublisherDocumentAreaStyleGap.md) + - [PublisherDocumentAttributeElements](docs/PublisherDocumentAttributeElements.md) + - [PublisherDocumentAttributeElementsByUri](docs/PublisherDocumentAttributeElementsByUri.md) + - [PublisherDocumentAttributeElementsByValue](docs/PublisherDocumentAttributeElementsByValue.md) + - [PublisherDocumentAttributeFilter](docs/PublisherDocumentAttributeFilter.md) + - [PublisherDocumentAttributeFilterAttributeFilter](docs/PublisherDocumentAttributeFilterAttributeFilter.md) + - [PublisherDocumentAttributeFilterByDate](docs/PublisherDocumentAttributeFilterByDate.md) + - [PublisherDocumentAttributeFilterConfig](docs/PublisherDocumentAttributeFilterConfig.md) + - [PublisherDocumentAttributeFilterParent](docs/PublisherDocumentAttributeFilterParent.md) + - [PublisherDocumentAttributeFilterParentOver](docs/PublisherDocumentAttributeFilterParentOver.md) + - [PublisherDocumentAttributeFilterReference](docs/PublisherDocumentAttributeFilterReference.md) + - [PublisherDocumentAutoVisibility](docs/PublisherDocumentAutoVisibility.md) + - [PublisherDocumentAutoVisibilityVisible](docs/PublisherDocumentAutoVisibilityVisible.md) + - [PublisherDocumentAxisDisplay](docs/PublisherDocumentAxisDisplay.md) + - [PublisherDocumentAxisNameDisplay](docs/PublisherDocumentAxisNameDisplay.md) + - [PublisherDocumentAxisValuesDisplay](docs/PublisherDocumentAxisValuesDisplay.md) + - [PublisherDocumentBoundedFilter](docs/PublisherDocumentBoundedFilter.md) + - [PublisherDocumentChartStyle](docs/PublisherDocumentChartStyle.md) + - [PublisherDocumentColumn](docs/PublisherDocumentColumn.md) + - [PublisherDocumentComparisonCondition](docs/PublisherDocumentComparisonCondition.md) + - [PublisherDocumentContainerStyle](docs/PublisherDocumentContainerStyle.md) + - [PublisherDocumentContainerStyleBorderBottomLeftRadius](docs/PublisherDocumentContainerStyleBorderBottomLeftRadius.md) + - [PublisherDocumentContainerStylePadding](docs/PublisherDocumentContainerStylePadding.md) + - [PublisherDocumentContent](docs/PublisherDocumentContent.md) + - [PublisherDocumentDataSetRef](docs/PublisherDocumentDataSetRef.md) + - [PublisherDocumentDateFilter](docs/PublisherDocumentDateFilter.md) + - [PublisherDocumentDateFilterDateFilter](docs/PublisherDocumentDateFilterDateFilter.md) + - [PublisherDocumentDateFilterDateFilterFrom](docs/PublisherDocumentDateFilterDateFilterFrom.md) + - [PublisherDocumentDateFilterReference](docs/PublisherDocumentDateFilterReference.md) + - [PublisherDocumentDefaults](docs/PublisherDocumentDefaults.md) + - [PublisherDocumentFilter](docs/PublisherDocumentFilter.md) + - [PublisherDocumentFilterReference](docs/PublisherDocumentFilterReference.md) + - [PublisherDocumentHeadingWidget](docs/PublisherDocumentHeadingWidget.md) + - [PublisherDocumentHeadlineStyle](docs/PublisherDocumentHeadlineStyle.md) + - [PublisherDocumentImageWidget](docs/PublisherDocumentImageWidget.md) + - [PublisherDocumentImageWidgetStyle](docs/PublisherDocumentImageWidgetStyle.md) + - [PublisherDocumentLayoutNode](docs/PublisherDocumentLayoutNode.md) + - [PublisherDocumentLegendDisplay](docs/PublisherDocumentLegendDisplay.md) + - [PublisherDocumentMatchAttributeFilter](docs/PublisherDocumentMatchAttributeFilter.md) + - [PublisherDocumentMatchAttributeFilterMatchAttributeFilter](docs/PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md) + - [PublisherDocumentMeasureValueCondition](docs/PublisherDocumentMeasureValueCondition.md) + - [PublisherDocumentMeasureValueFilter](docs/PublisherDocumentMeasureValueFilter.md) + - [PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter](docs/PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.md) + - [PublisherDocumentMeasureValueFilterReference](docs/PublisherDocumentMeasureValueFilterReference.md) + - [PublisherDocumentObjRef](docs/PublisherDocumentObjRef.md) + - [PublisherDocumentPage](docs/PublisherDocumentPage.md) + - [PublisherDocumentPageStyle](docs/PublisherDocumentPageStyle.md) + - [PublisherDocumentPageTemplateContent](docs/PublisherDocumentPageTemplateContent.md) + - [PublisherDocumentPeriod](docs/PublisherDocumentPeriod.md) + - [PublisherDocumentRangeCondition](docs/PublisherDocumentRangeCondition.md) + - [PublisherDocumentRow](docs/PublisherDocumentRow.md) + - [PublisherDocumentSection](docs/PublisherDocumentSection.md) + - [PublisherDocumentTableStyle](docs/PublisherDocumentTableStyle.md) + - [PublisherDocumentTakeawayContext](docs/PublisherDocumentTakeawayContext.md) + - [PublisherDocumentTakeawayDefaults](docs/PublisherDocumentTakeawayDefaults.md) + - [PublisherDocumentTakeawayGeneration](docs/PublisherDocumentTakeawayGeneration.md) + - [PublisherDocumentTakeawayWidget](docs/PublisherDocumentTakeawayWidget.md) + - [PublisherDocumentTextStyle](docs/PublisherDocumentTextStyle.md) + - [PublisherDocumentTextWidget](docs/PublisherDocumentTextWidget.md) + - [PublisherDocumentTextWidgetStyle](docs/PublisherDocumentTextWidgetStyle.md) + - [PublisherDocumentTitleWidget](docs/PublisherDocumentTitleWidget.md) + - [PublisherDocumentVisibility](docs/PublisherDocumentVisibility.md) + - [PublisherDocumentVisualizationDisplay](docs/PublisherDocumentVisualizationDisplay.md) + - [PublisherDocumentVisualizationRef](docs/PublisherDocumentVisualizationRef.md) + - [PublisherDocumentVisualizationStyle](docs/PublisherDocumentVisualizationStyle.md) + - [PublisherDocumentVisualizationWidget](docs/PublisherDocumentVisualizationWidget.md) + - [PublisherDocumentWidgetPlaceholder](docs/PublisherDocumentWidgetPlaceholder.md) + - [PublisherDocumentWidgetTitle](docs/PublisherDocumentWidgetTitle.md) - [QualityIssue](docs/QualityIssue.md) - [QualityIssueObject](docs/QualityIssueObject.md) - [QualityIssuesCalculationStatusResponse](docs/QualityIssuesCalculationStatusResponse.md) @@ -2813,6 +3049,8 @@ Class | Method | HTTP request | Description - [RelativeBoundedDateFilter](docs/RelativeBoundedDateFilter.md) - [RelativeDateFilter](docs/RelativeDateFilter.md) - [RelativeDateFilterRelativeDateFilter](docs/RelativeDateFilterRelativeDateFilter.md) + - [RelativePublisherDocumentPeriod](docs/RelativePublisherDocumentPeriod.md) + - [RelativePublisherDocumentPeriodAllOf](docs/RelativePublisherDocumentPeriodAllOf.md) - [RelativeWrapper](docs/RelativeWrapper.md) - [RemoveDatabaseDataSourceResponse](docs/RemoveDatabaseDataSourceResponse.md) - [ReportExportRequest](docs/ReportExportRequest.md) @@ -2939,6 +3177,7 @@ Class | Method | HTTP request | Description - [WorkspaceDashboardSlidesTemplate](docs/WorkspaceDashboardSlidesTemplate.md) - [WorkspaceDataSource](docs/WorkspaceDataSource.md) - [WorkspaceIdentifier](docs/WorkspaceIdentifier.md) + - [WorkspaceLocalizationUsage](docs/WorkspaceLocalizationUsage.md) - [WorkspacePermissionAssignment](docs/WorkspacePermissionAssignment.md) - [WorkspaceUser](docs/WorkspaceUser.md) - [WorkspaceUserGroup](docs/WorkspaceUserGroup.md) diff --git a/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md index 9737918b4..0ef107fba 100644 --- a/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteGranularityDateFilter.md @@ -1,6 +1,6 @@ # AbsoluteGranularityDateFilter -An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. +An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range. ## Properties Name | Type | Description | Notes diff --git a/gooddata-api-client/docs/AbsolutePublisherDocumentPeriod.md b/gooddata-api-client/docs/AbsolutePublisherDocumentPeriod.md new file mode 100644 index 000000000..29874b6b7 --- /dev/null +++ b/gooddata-api-client/docs/AbsolutePublisherDocumentPeriod.md @@ -0,0 +1,16 @@ +# AbsolutePublisherDocumentPeriod + +A period between two dates. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **date** | First day of the period, inclusive. | +**to** | **date** | Last day of the period, inclusive. | +**type** | **str** | | defaults to "absolute" +**granularity** | **str** | Date granularity of the period. | defaults to "GDC.time.date" +**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/AbsolutePublisherDocumentPeriodAllOf.md b/gooddata-api-client/docs/AbsolutePublisherDocumentPeriodAllOf.md new file mode 100644 index 000000000..ac9cb9d37 --- /dev/null +++ b/gooddata-api-client/docs/AbsolutePublisherDocumentPeriodAllOf.md @@ -0,0 +1,15 @@ +# AbsolutePublisherDocumentPeriodAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **date** | First day of the period, inclusive. | [optional] +**granularity** | **str** | Date granularity of the period. | [optional] if omitted the server will use the default value of "GDC.time.date" +**to** | **date** | Last day of the period, inclusive. | [optional] +**type** | **str** | Type of the period. | [optional] if omitted the server will use the default value of "absolute" +**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 deaa7aaea..282ea1f19 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description [**ai_chat_usage**](ActionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | (REMOVED) Get Chat Usage [**all_platform_usage**](ActionsApi.md#all_platform_usage) | **GET** /api/v1/actions/collectUsage | Info about the platform usage. [**analyze_csv**](ActionsApi.md#analyze_csv) | **POST** /api/v1/actions/fileStorage/staging/analyzeCsv | Analyze CSV +[**analyze_sav**](ActionsApi.md#analyze_sav) | **POST** /api/v1/actions/fileStorage/staging/analyzeSav | Analyze SPSS files [**anomaly_detection**](ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection [**anomaly_detection_result**](ActionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result [**attribute_permissions**](ActionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions @@ -33,6 +34,7 @@ Method | HTTP request | Description [**computed_attribute_permissions**](ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions [**convert_geo_file**](ActionsApi.md#convert_geo_file) | **POST** /api/v1/actions/customGeoCollection/convert | Convert a geo file to GeoParquet format [**create_dashboard_export_request**](ActionsApi.md#create_dashboard_export_request) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular | (EXPERIMENTAL) Create dashboard tabular export request +[**create_document_export**](ActionsApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request [**create_image_export**](ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request [**create_pdf_export**](ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request [**create_raw_export**](ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request @@ -56,6 +58,8 @@ Method | HTTP request | Description [**get_data_source_schemata**](ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database [**get_dependent_entities_graph**](ActionsApi.md#get_dependent_entities_graph) | **GET** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph [**get_dependent_entities_graph_from_entry_points**](ActionsApi.md#get_dependent_entities_graph_from_entry_points) | **POST** /api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph | Computes the dependent entities graph from given entry points +[**get_document_export**](ActionsApi.md#get_document_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId} | (EXPERIMENTAL) Retrieve exported document +[**get_document_export_metadata**](ActionsApi.md#get_document_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata | (EXPERIMENTAL) Retrieve document export metadata [**get_exported_file**](ActionsApi.md#get_exported_file) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId} | Retrieve exported files [**get_image_export**](ActionsApi.md#get_image_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId} | (EXPERIMENTAL) Retrieve exported files [**get_image_export_metadata**](ActionsApi.md#get_image_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context @@ -72,6 +76,7 @@ Method | HTTP request | Description [**get_translation_tags**](ActionsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags. [**import_csv**](ActionsApi.md#import_csv) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv | Import CSV [**import_custom_geo_collection**](ActionsApi.md#import_custom_geo_collection) | **POST** /api/v1/actions/customGeoCollection/{collectionId}/import | Import custom geo collection +[**import_sav**](ActionsApi.md#import_sav) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav | Import SPSS files [**inherited_entity_conflicts**](ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. [**inherited_entity_prefixes**](ActionsApi.md#inherited_entity_prefixes) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes | Get used entity prefixes in hierarchy [**key_driver_analysis**](ActionsApi.md#key_driver_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers | (EXPERIMENTAL) Compute key driver analysis @@ -97,6 +102,10 @@ Method | HTTP request | Description [**mark_as_read_notification_all**](ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. [**memory_created_by_users**](ActionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users [**metric_permissions**](ActionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions +[**organization_localization_statistics**](ActionsApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. +[**organization_localization_usage**](ActionsApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. +[**organization_localization_usage_users**](ActionsApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. +[**organization_localization_usage_workspaces**](ActionsApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. [**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. @@ -150,6 +159,9 @@ Method | HTTP request | Description [**validate_llm_endpoint**](ActionsApi.md#validate_llm_endpoint) | **POST** /api/v1/actions/ai/llmEndpoint/test | Validate LLM Endpoint (Removed) [**validate_llm_endpoint_by_id**](ActionsApi.md#validate_llm_endpoint_by_id) | **POST** /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test | Validate LLM Endpoint By Id (Removed) [**visualization_permissions**](ActionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions +[**workspace_localization_statistics**](ActionsApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. +[**workspace_localization_usage**](ActionsApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. +[**workspace_localization_usage_users**](ActionsApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. [**workspace_resolve_all_settings**](ActionsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. [**workspace_resolve_settings**](ActionsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. @@ -624,6 +636,83 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful analysis. | - | + +[[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_sav** +> [AnalyzeSavResponse] analyze_sav(analyze_sav_request) + +Analyze SPSS files + +Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse +from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest +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) + analyze_sav_request = AnalyzeSavRequest( + analyze_requests=[ + AnalyzeSavRequestItem( + config=AnalyzeSavRequestItemConfig( + result_rows=1, + ), + location="location_example", + ), + ], + ) # AnalyzeSavRequest | + + # example passing only required values which don't have defaults set + try: + # Analyze SPSS files + api_response = api_instance.analyze_sav(analyze_sav_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->analyze_sav: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **analyze_sav_request** | [**AnalyzeSavRequest**](AnalyzeSavRequest.md)| | + +### Return type + +[**[AnalyzeSavResponse]**](AnalyzeSavResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -2526,6 +2615,94 @@ 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_document_export** +> ExportResponse create_document_export(workspace_id, report_export_request) + +(EXPERIMENTAL) Create document export request + +Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.report_export_request import ReportExportRequest +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 | + report_export_request = ReportExportRequest( + document_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + report_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + timezone_id="Asia/Kolkata", + ) # ReportExportRequest | + x_gdc_debug = 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: + # (EXPERIMENTAL) Create document export request + api_response = api_instance.create_document_export(workspace_id, report_export_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_document_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create document export request + api_response = api_instance.create_document_export(workspace_id, report_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_document_export: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **report_export_request** | [**ReportExportRequest**](ReportExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**ExportResponse**](ExportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Document export request created successfully. | - | + +[[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_image_export** > ExportResponse create_image_export(workspace_id, image_export_request) @@ -2845,7 +3022,7 @@ No authorization required (EXPERIMENTAL) Create report export request -Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. +Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. ### Example @@ -2870,6 +3047,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) workspace_id = "workspaceId_example" # str | report_export_request = ReportExportRequest( + document_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", format="PDF", metadata=JsonNode(), @@ -4222,6 +4400,7 @@ with gooddata_api_client.ApiClient() as api_client: columns=[ DeclarativeColumn( data_type="INT", + default_label_of="gender", description="Customer unique identifier", is_nullable=True, is_primary_key=True, @@ -4234,6 +4413,9 @@ with gooddata_api_client.ApiClient() as api_client: id="customers", name_prefix="out_gooddata", path=["table_schema","table_name"], + properties={ + "key": "key_example", + }, type="TABLE", ), ], @@ -4573,12 +4755,12 @@ 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_exported_file** -> file_type get_exported_file(workspace_id, export_id) +# **get_document_export** +> file_type get_document_export(workspace_id, export_id) -Retrieve exported files +(EXPERIMENTAL) Retrieve exported document -Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. +Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -4587,6 +4769,7 @@ Returns 202 until original POST export request is not processed.Returns 200 with import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. @@ -4604,11 +4787,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Retrieve exported files - api_response = api_instance.get_exported_file(workspace_id, export_id) + # (EXPERIMENTAL) Retrieve exported document + api_response = api_instance.get_document_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_exported_file: %s\n" % e) + print("Exception when calling ActionsApi->get_document_export: %s\n" % e) ``` @@ -4630,7 +4813,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/pdf, application/zip + - **Accept**: application/pdf ### HTTP response details @@ -4642,12 +4825,12 @@ 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_image_export** -> file_type get_image_export(workspace_id, export_id) +# **get_document_export_metadata** +> get_document_export_metadata(workspace_id, export_id) -(EXPERIMENTAL) Retrieve exported files +(EXPERIMENTAL) Retrieve document export metadata -Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. +Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified. ### Example @@ -4656,7 +4839,6 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner 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. @@ -4674,11 +4856,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Retrieve exported files - api_response = api_instance.get_image_export(workspace_id, export_id) - pprint(api_response) + # (EXPERIMENTAL) Retrieve document export metadata + api_instance.get_document_export_metadata(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_image_export: %s\n" % e) + print("Exception when calling ActionsApi->get_document_export_metadata: %s\n" % e) ``` @@ -4691,7 +4872,7 @@ Name | Type | Description | Notes ### Return type -**file_type** +void (empty response body) ### Authorization @@ -4700,24 +4881,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: image/png + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Binary export result. | * Content-Disposition -
| -**202** | Request is accepted, provided exportId exists, but export is not yet ready. | - | +**200** | Json metadata representation | - | [[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_image_export_metadata** -> get_image_export_metadata(workspace_id, export_id) +# **get_exported_file** +> file_type get_exported_file(workspace_id, export_id) -(EXPERIMENTAL) Retrieve metadata context +Retrieve exported files -Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. +Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done. ### Example @@ -4743,10 +4923,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (EXPERIMENTAL) Retrieve metadata context - api_instance.get_image_export_metadata(workspace_id, export_id) + # Retrieve exported files + api_response = api_instance.get_exported_file(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_image_export_metadata: %s\n" % e) + print("Exception when calling ActionsApi->get_exported_file: %s\n" % e) ``` @@ -4759,7 +4940,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -4768,23 +4949,24 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/pdf, application/zip ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Json metadata representation | - | +**200** | Binary export result. | * Content-Disposition -
| +**202** | Request is accepted, provided exportId exists, but export is not yet ready. | - | [[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_metadata** -> get_metadata(workspace_id, export_id) +# **get_image_export** +> file_type get_image_export(workspace_id, export_id) -Retrieve metadata context +(EXPERIMENTAL) Retrieve exported files -This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. +Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -4793,6 +4975,7 @@ This endpoint serves as a cache for user-defined metadata of the export for the import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. @@ -4810,10 +4993,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Retrieve metadata context - api_instance.get_metadata(workspace_id, export_id) + # (EXPERIMENTAL) Retrieve exported files + api_response = api_instance.get_image_export(workspace_id, export_id) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_metadata: %s\n" % e) + print("Exception when calling ActionsApi->get_image_export: %s\n" % e) ``` @@ -4826,7 +5010,7 @@ Name | Type | Description | Notes ### Return type -void (empty response body) +**file_type** ### Authorization @@ -4835,23 +5019,24 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: image/png ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Json metadata representation | - | +**200** | Binary export result. | * Content-Disposition -
| +**202** | Request is accepted, provided exportId exists, but export is not yet ready. | - | [[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_notifications** -> Notifications get_notifications() +# **get_image_export_metadata** +> get_image_export_metadata(workspace_id, export_id) -Get latest notifications. +(EXPERIMENTAL) Retrieve metadata context -Get latest in-platform notifications for the current user. +Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified. ### Example @@ -4860,7 +5045,6 @@ Get latest in-platform notifications for the current user. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.notifications import Notifications 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. @@ -4873,22 +5057,15 @@ 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 = "workspaceId_example" # str | Workspace ID to filter notifications by. (optional) - is_read = True # bool | Filter notifications by read status. (optional) - page = "0" # str | Zero-based page index (0..N) (optional) if omitted the server will use the default value of "0" - size = "20" # str | The size of the page to be returned. (optional) if omitted the server will use the default value of "20" - meta_include = [ - "total", - ] # [str] | Additional meta information to include in the response. (optional) + workspace_id = "workspaceId_example" # str | + export_id = "exportId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get latest notifications. - api_response = api_instance.get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) - pprint(api_response) + # (EXPERIMENTAL) Retrieve metadata context + api_instance.get_image_export_metadata(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_notifications: %s\n" % e) + print("Exception when calling ActionsApi->get_image_export_metadata: %s\n" % e) ``` @@ -4896,15 +5073,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] - **is_read** | **bool**| Filter notifications by read status. | [optional] - **page** | **str**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of "0" - **size** | **str**| The size of the page to be returned. | [optional] if omitted the server will use the default value of "20" - **meta_include** | **[str]**| Additional meta information to include in the response. | [optional] + **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -[**Notifications**](Notifications.md) +void (empty response body) ### Authorization @@ -4920,16 +5094,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**200** | Json metadata representation | - | [[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_quality_issues** -> GetQualityIssuesResponse get_quality_issues(workspace_id) +# **get_metadata** +> get_metadata(workspace_id, export_id) -Get Quality Issues +Retrieve metadata context -Returns metadata quality issues detected by the platform linter. +This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. ### Example @@ -4938,7 +5112,6 @@ Returns metadata quality issues detected by the platform linter. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse 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. @@ -4951,8 +5124,154 @@ 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 | + export_id = "exportId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Retrieve metadata context + api_instance.get_metadata(workspace_id, export_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->get_metadata: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **export_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Json metadata representation | - | + +[[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_notifications** +> Notifications get_notifications() + +Get latest notifications. + +Get latest in-platform notifications for the current user. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.notifications import Notifications +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 | Workspace ID to filter notifications by. (optional) + is_read = True # bool | Filter notifications by read status. (optional) + page = "0" # str | Zero-based page index (0..N) (optional) if omitted the server will use the default value of "0" + size = "20" # str | The size of the page to be returned. (optional) if omitted the server will use the default value of "20" + meta_include = [ + "total", + ] # [str] | Additional meta information to include in the response. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get latest notifications. + api_response = api_instance.get_notifications(workspace_id=workspace_id, is_read=is_read, page=page, size=size, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->get_notifications: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace ID to filter notifications by. | [optional] + **is_read** | **bool**| Filter notifications by read status. | [optional] + **page** | **str**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of "0" + **size** | **str**| The size of the page to be returned. | [optional] if omitted the server will use the default value of "20" + **meta_include** | **[str]**| Additional meta information to include in the response. | [optional] + +### Return type + +[**Notifications**](Notifications.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) + +# **get_quality_issues** +> GetQualityIssuesResponse get_quality_issues(workspace_id) + +Get Quality Issues + +Returns metadata quality issues detected by the platform linter. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + # example passing only required values which don't have defaults set try: # Get Quality Issues @@ -5134,7 +5453,7 @@ No authorization required (EXPERIMENTAL) Retrieve exported files -Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. +Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -5143,7 +5462,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. @@ -5204,7 +5523,7 @@ No authorization required (EXPERIMENTAL) Retrieve metadata context -Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. +Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. ### Example @@ -5280,7 +5599,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. @@ -5543,7 +5862,7 @@ No authorization required Import CSV -Import the CSV files at the given locations in the staging area to the final location. +Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file. ### Example @@ -5736,6 +6055,85 @@ No authorization required - **Accept**: */* +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful import. | - | + +[[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) + +# **import_sav** +> [ImportSavResponse] import_sav(data_source_id, import_sav_request) + +Import SPSS files + +Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.import_sav_response import ImportSavResponse +from gooddata_api_client.model.import_sav_request import ImportSavRequest +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) + data_source_id = "dataSourceId_example" # str | + import_sav_request = ImportSavRequest( + tables=[ + ImportSavRequestTable( + name="name_example", + source=ImportSavRequestTableSource( + location="location_example", + ), + ), + ], + ) # ImportSavRequest | + + # example passing only required values which don't have defaults set + try: + # Import SPSS files + api_response = api_instance.import_sav(data_source_id, import_sav_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->import_sav: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data_source_id** | **str**| | + **import_sav_request** | [**ImportSavRequest**](ImportSavRequest.md)| | + +### Return type + +[**[ImportSavResponse]**](ImportSavResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -7274,9 +7672,274 @@ No authorization required # **mark_as_read_notification** > mark_as_read_notification(notification_id) -Mark notification as read. +Mark notification as read. + +Mark in-platform notification by its ID as read. + +### 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) + notification_id = "notificationId_example" # str | Notification ID to mark as read. + + # example passing only required values which don't have defaults set + try: + # Mark notification as read. + api_instance.mark_as_read_notification(notification_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->mark_as_read_notification: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notification_id** | **str**| Notification ID to mark as read. | + +### 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) + +# **mark_as_read_notification_all** +> mark_as_read_notification_all() + +Mark all notifications as read. + +Mark all user in-platform notifications as read. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | Workspace ID where to mark notifications as read. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Mark all notifications as read. + api_instance.mark_as_read_notification_all(workspace_id=workspace_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->mark_as_read_notification_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**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) + +# **memory_created_by_users** +> MemoryItemCreatedByUsers memory_created_by_users(workspace_id) + +Get AI Memory CreatedBy Users + +Returns a list of Users who created any memory item for this workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + + # example passing only required values which don't have defaults set + try: + # Get AI Memory CreatedBy Users + api_response = api_instance.memory_created_by_users(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->memory_created_by_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +[**MemoryItemCreatedByUsers**](MemoryItemCreatedByUsers.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) + +# **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 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. +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 | + + # 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 ActionsApi->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) + +# **organization_localization_statistics** +> LocalizationStatistics organization_localization_statistics() -Mark in-platform notification by its ID as read. +(BETA) Languages with translations in the organization. + +(BETA) Lists the languages that have at least one translation, separately for each kind of translation. ### Example @@ -7285,6 +7948,7 @@ Mark in-platform notification by its ID as read. import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_statistics import LocalizationStatistics 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. @@ -7297,26 +7961,23 @@ 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) - notification_id = "notificationId_example" # str | Notification ID to mark as read. - # example passing only required values which don't have defaults set + # example, this endpoint has no required or optional parameters try: - # Mark notification as read. - api_instance.mark_as_read_notification(notification_id) + # (BETA) Languages with translations in the organization. + api_response = api_instance.organization_localization_statistics() + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->mark_as_read_notification: %s\n" % e) + print("Exception when calling ActionsApi->organization_localization_statistics: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **notification_id** | **str**| Notification ID to mark as read. | +This endpoint does not need any parameter. ### Return type -void (empty response body) +[**LocalizationStatistics**](LocalizationStatistics.md) ### Authorization @@ -7325,23 +7986,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**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) -# **mark_as_read_notification_all** -> mark_as_read_notification_all() +# **organization_localization_usage** +> LocalizationUsage organization_localization_usage() -Mark all notifications as read. +(BETA) Languages used in the organization. -Mark all user in-platform notifications as read. +(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. ### Example @@ -7350,6 +8011,7 @@ Mark all user in-platform notifications as read. import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_usage import LocalizationUsage 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. @@ -7362,27 +8024,23 @@ 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 = "workspaceId_example" # str | Workspace ID where to mark notifications as read. (optional) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Mark all notifications as read. - api_instance.mark_as_read_notification_all(workspace_id=workspace_id) + # (BETA) Languages used in the organization. + api_response = api_instance.organization_localization_usage() + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->mark_as_read_notification_all: %s\n" % e) + print("Exception when calling ActionsApi->organization_localization_usage: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace ID where to mark notifications as read. | [optional] +This endpoint does not need any parameter. ### Return type -void (empty response body) +[**LocalizationUsage**](LocalizationUsage.md) ### Authorization @@ -7391,23 +8049,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | No Content | - | +**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) -# **memory_created_by_users** -> MemoryItemCreatedByUsers memory_created_by_users(workspace_id) +# **organization_localization_usage_users** +> LocalizationUsageUsers organization_localization_usage_users() -Get AI Memory CreatedBy Users +(BETA) Users who set a language themselves. -Returns a list of Users who created any memory item for this workspace +(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed. ### Example @@ -7416,7 +8074,7 @@ Returns a list of Users who created any memory item for this workspace import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers 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. @@ -7429,15 +8087,21 @@ 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 + value = "de-DE" # str | Language tag that the user sets. (optional) + name = "ito" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "USER" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 # example passing only required values which don't have defaults set + # and optional values try: - # Get AI Memory CreatedBy Users - api_response = api_instance.memory_created_by_users(workspace_id) + # (BETA) Users who set a language themselves. + api_response = api_instance.organization_localization_usage_users(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->memory_created_by_users: %s\n" % e) + print("Exception when calling ActionsApi->organization_localization_usage_users: %s\n" % e) ``` @@ -7445,11 +8109,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **value** | **str**| Language tag that the user sets. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 ### Return type -[**MemoryItemCreatedByUsers**](MemoryItemCreatedByUsers.md) +[**LocalizationUsageUsers**](LocalizationUsageUsers.md) ### Authorization @@ -7469,10 +8138,12 @@ 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) +# **organization_localization_usage_workspaces** +> LocalizationUsageWorkspaces organization_localization_usage_workspaces() -(BETA) Get Metric Permissions +(BETA) Workspaces that use a language. + +(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. ### Example @@ -7481,7 +8152,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 gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -7494,16 +8165,21 @@ 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 = "workspaceId_example" # str | - metric_id = "metricId_example" # str | + value = "de-DE" # str | Language tag that the workspace gets. (optional) + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "PARENT" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 # example passing only required values which don't have defaults set + # and optional values try: - # (BETA) Get Metric Permissions - api_response = api_instance.metric_permissions(workspace_id, metric_id) + # (BETA) Workspaces that use a language. + api_response = api_instance.organization_localization_usage_workspaces(value=value, name=name, setting=setting, source=source, page=page, size=size) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->metric_permissions: %s\n" % e) + print("Exception when calling ActionsApi->organization_localization_usage_workspaces: %s\n" % e) ``` @@ -7511,12 +8187,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **metric_id** | **str**| | + **value** | **str**| Language tag that the workspace gets. | [optional] + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 ### Return type -[**MetricPermissions**](MetricPermissions.md) +[**LocalizationUsageWorkspaces**](LocalizationUsageWorkspaces.md) ### Authorization @@ -11752,6 +12432,228 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workspace_localization_statistics** +> LocalizationStatistics workspace_localization_statistics(workspace_id) + +(BETA) Languages with translations in the workspace. + +(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_statistics import LocalizationStatistics +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Languages with translations in the workspace. + api_response = api_instance.workspace_localization_statistics(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**LocalizationStatistics**](LocalizationStatistics.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) + +# **workspace_localization_usage** +> WorkspaceLocalizationUsage workspace_localization_usage(workspace_id) + +(BETA) Languages used in the workspace. + +(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.workspace_localization_usage import WorkspaceLocalizationUsage +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Languages used in the workspace. + api_response = api_instance.workspace_localization_usage(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_usage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**WorkspaceLocalizationUsage**](WorkspaceLocalizationUsage.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) + +# **workspace_localization_usage_users** +> LocalizationUsageUsers workspace_localization_usage_users(workspace_id) + +(BETA) Workspace members who get a language. + +(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "workspaceId_example" # str | + value = "de-DE" # str | Language tag that the user gets. (optional) + name = "ito" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "WORKSPACE" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspace members who get a language. + api_response = api_instance.workspace_localization_usage_users(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_usage_users: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspace members who get a language. + api_response = api_instance.workspace_localization_usage_users(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->workspace_localization_usage_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **value** | **str**| Language tag that the user gets. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageUsers**](LocalizationUsageUsers.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index 2a7022bb9..ff2d4ae27 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -230,6 +230,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -321,10 +634,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -426,6 +793,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), diff --git a/gooddata-api-client/docs/AnalyzeSavRequest.md b/gooddata-api-client/docs/AnalyzeSavRequest.md new file mode 100644 index 000000000..6428501b2 --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavRequest.md @@ -0,0 +1,13 @@ +# AnalyzeSavRequest + +Bulk SPSS (.sav) file analysis request. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**analyze_requests** | [**[AnalyzeSavRequestItem]**](AnalyzeSavRequestItem.md) | List of individual SPSS file analysis requests. | +**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/AnalyzeSavRequestItem.md b/gooddata-api-client/docs/AnalyzeSavRequestItem.md new file mode 100644 index 000000000..23cdbc194 --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavRequestItem.md @@ -0,0 +1,14 @@ +# AnalyzeSavRequestItem + +SPSS (.sav) file analysis request. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | **str** | Location of the SPSS file to analyze. | +**config** | [**AnalyzeSavRequestItemConfig**](AnalyzeSavRequestItemConfig.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/AnalyzeSavRequestItemConfig.md b/gooddata-api-client/docs/AnalyzeSavRequestItemConfig.md new file mode 100644 index 000000000..59c75ef47 --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavRequestItemConfig.md @@ -0,0 +1,13 @@ +# AnalyzeSavRequestItemConfig + +SPSS (.sav) file analysis request config. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result_rows** | **int** | Number of rows to return as the preview of the file. The default is 100, the maximum is 1000. | [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/AnalyzeSavResponse.md b/gooddata-api-client/docs/AnalyzeSavResponse.md new file mode 100644 index 000000000..c9dc0771e --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavResponse.md @@ -0,0 +1,15 @@ +# AnalyzeSavResponse + +Describes the results of an analysis of a single SPSS (.sav) file. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**columns** | [**[AnalyzeSavResponseColumn]**](AnalyzeSavResponseColumn.md) | List of column metadata. | +**location** | **str** | Location of the analyzed file in the source data source. | +**preview_data** | **[[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]** | Preview of the first N rows of the file. | +**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/AnalyzeSavResponseColumn.md b/gooddata-api-client/docs/AnalyzeSavResponseColumn.md new file mode 100644 index 000000000..481f1f488 --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavResponseColumn.md @@ -0,0 +1,16 @@ +# AnalyzeSavResponseColumn + +Describes a column of an SPSS file. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the column as specified in the file. | +**type** | **str** | Type of the column (e.g. string, float64, date32). | +**label** | **str** | Label of the column, in a survey file usually the question text. Null if there is none. | [optional] +**value_labels** | [**[AnalyzeSavResponseValueLabel]**](AnalyzeSavResponseValueLabel.md) | Labels of the column values in file order. Null if there are none. | [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/AnalyzeSavResponseValueLabel.md b/gooddata-api-client/docs/AnalyzeSavResponseValueLabel.md new file mode 100644 index 000000000..7a214bbdc --- /dev/null +++ b/gooddata-api-client/docs/AnalyzeSavResponseValueLabel.md @@ -0,0 +1,14 @@ +# AnalyzeSavResponseValueLabel + +Label of one value of an SPSS column. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **str** | The label of the value, in a survey file usually the answer text. | +**value** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The value: a number in a numeric column, a string in a string 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/AttributeHeaderAttributeHeader.md b/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md index b8fb93877..1c79ee3b8 100644 --- a/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md +++ b/gooddata-api-client/docs/AttributeHeaderAttributeHeader.md @@ -10,9 +10,11 @@ Name | Type | Description | Notes **label_name** | **str** | Label name. | **local_identifier** | **str** | Local identifier of the attribute this header relates to. | **primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | +**data_type** | **str** | Data type of the attribute values, only filled for computed attributes. | [optional] **format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] **geo_area_config** | [**GeoAreaConfig**](GeoAreaConfig.md) | | [optional] **granularity** | **str** | Date granularity of the attribute, only filled for date attributes. | [optional] +**number_format** | **str** | Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format. | [optional] **value_type** | **str** | Attribute value 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] diff --git a/gooddata-api-client/docs/DataSourceControllerApi.md b/gooddata-api-client/docs/DataSourceControllerApi.md index 3d1e74e5b..d586d7eb5 100644 --- a/gooddata-api-client/docs/DataSourceControllerApi.md +++ b/gooddata-api-client/docs/DataSourceControllerApi.md @@ -51,6 +51,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -390,6 +391,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -501,6 +503,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( diff --git a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md index 00585613c..919b60c2a 100644 --- a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md @@ -116,6 +116,7 @@ with gooddata_api_client.ApiClient() as api_client: ], disable_statistics=True, id="pg_local_docker-demo", + ignore_jwt_aud=True, name="postgres demo", parameters=[ Parameter( diff --git a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md index aa1d387e6..73797062d 100644 --- a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md @@ -53,6 +53,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -550,6 +551,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -661,6 +663,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( diff --git a/gooddata-api-client/docs/DataSourceFilesAnalysisApi.md b/gooddata-api-client/docs/DataSourceFilesAnalysisApi.md index c72f62a76..df986539f 100644 --- a/gooddata-api-client/docs/DataSourceFilesAnalysisApi.md +++ b/gooddata-api-client/docs/DataSourceFilesAnalysisApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**analyze_csv**](DataSourceFilesAnalysisApi.md#analyze_csv) | **POST** /api/v1/actions/fileStorage/staging/analyzeCsv | Analyze CSV +[**analyze_sav**](DataSourceFilesAnalysisApi.md#analyze_sav) | **POST** /api/v1/actions/fileStorage/staging/analyzeSav | Analyze SPSS files # **analyze_csv** @@ -89,3 +90,80 @@ 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_sav** +> [AnalyzeSavResponse] analyze_sav(analyze_sav_request) + +Analyze SPSS files + +Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_files_analysis_api +from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse +from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest +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 = data_source_files_analysis_api.DataSourceFilesAnalysisApi(api_client) + analyze_sav_request = AnalyzeSavRequest( + analyze_requests=[ + AnalyzeSavRequestItem( + config=AnalyzeSavRequestItemConfig( + result_rows=1, + ), + location="location_example", + ), + ], + ) # AnalyzeSavRequest | + + # example passing only required values which don't have defaults set + try: + # Analyze SPSS files + api_response = api_instance.analyze_sav(analyze_sav_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceFilesAnalysisApi->analyze_sav: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **analyze_sav_request** | [**AnalyzeSavRequest**](AnalyzeSavRequest.md)| | + +### Return type + +[**[AnalyzeSavResponse]**](AnalyzeSavResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful analysis. | - | + +[[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/DataSourceFilesImportApi.md b/gooddata-api-client/docs/DataSourceFilesImportApi.md index f408fc439..88f0dcfee 100644 --- a/gooddata-api-client/docs/DataSourceFilesImportApi.md +++ b/gooddata-api-client/docs/DataSourceFilesImportApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**import_csv**](DataSourceFilesImportApi.md#import_csv) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv | Import CSV +[**import_sav**](DataSourceFilesImportApi.md#import_sav) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav | Import SPSS files # **import_csv** @@ -12,7 +13,7 @@ Method | HTTP request | Description Import CSV -Import the CSV files at the given locations in the staging area to the final location. +Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file. ### Example @@ -141,3 +142,82 @@ 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) +# **import_sav** +> [ImportSavResponse] import_sav(data_source_id, import_sav_request) + +Import SPSS files + +Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import data_source_files_import_api +from gooddata_api_client.model.import_sav_response import ImportSavResponse +from gooddata_api_client.model.import_sav_request import ImportSavRequest +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 = data_source_files_import_api.DataSourceFilesImportApi(api_client) + data_source_id = "dataSourceId_example" # str | + import_sav_request = ImportSavRequest( + tables=[ + ImportSavRequestTable( + name="name_example", + source=ImportSavRequestTableSource( + location="location_example", + ), + ), + ], + ) # ImportSavRequest | + + # example passing only required values which don't have defaults set + try: + # Import SPSS files + api_response = api_instance.import_sav(data_source_id, import_sav_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DataSourceFilesImportApi->import_sav: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data_source_id** | **str**| | + **import_sav_request** | [**ImportSavRequest**](ImportSavRequest.md)| | + +### Return type + +[**[ImportSavResponse]**](ImportSavResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful import. | - | + +[[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/DeclarativeAnalyticalDashboard.md b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md index 198df35f3..e2977365b 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticalDashboard.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **description** | **str** | Analytical dashboard description. | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] -**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | [optional] +**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. A PUT without this property removes all existing permissions. | [optional] **summary** | **str** | AI-generated summary of the dashboard content | [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/DeclarativeAnalyticsLayer.md b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md index 9f5fe7992..9c8ebe289 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md @@ -9,10 +9,13 @@ Name | Type | Description | Notes **attribute_hierarchies** | [**[DeclarativeAttributeHierarchy]**](DeclarativeAttributeHierarchy.md) | A list of attribute hierarchies. | [optional] **computed_attributes** | [**[DeclarativeComputedAttribute]**](DeclarativeComputedAttribute.md) | A list of computed attributes available in the model. | [optional] **dashboard_plugins** | [**[DeclarativeDashboardPlugin]**](DeclarativeDashboardPlugin.md) | A list of dashboard plugins available in the model. | [optional] +**document_templates** | [**[DeclarativePublisherDocumentTemplate]**](DeclarativePublisherDocumentTemplate.md) | A list of document templates available in the model. | [optional] +**documents** | [**[DeclarativePublisherDocument]**](DeclarativePublisherDocument.md) | A list of documents available in the model. | [optional] **export_definitions** | [**[DeclarativeExportDefinition]**](DeclarativeExportDefinition.md) | A list of export definitions. | [optional] **filter_contexts** | [**[DeclarativeFilterContext]**](DeclarativeFilterContext.md) | A list of filter contexts available in the model. | [optional] **memory_items** | [**[DeclarativeMemoryItem]**](DeclarativeMemoryItem.md) | A list of AI memory items available in the workspace. | [optional] **metrics** | [**[DeclarativeMetric]**](DeclarativeMetric.md) | A list of metrics available in the model. | [optional] +**page_templates** | [**[DeclarativePublisherDocumentPageTemplate]**](DeclarativePublisherDocumentPageTemplate.md) | A list of page templates available in the model. | [optional] **parameters** | [**[DeclarativeParameter]**](DeclarativeParameter.md) | A list of parameters available in the model. | [optional] **report_page_layouts** | [**[DeclarativeReportPageLayout]**](DeclarativeReportPageLayout.md) | A list of report page layouts available in the model. | [optional] **report_templates** | [**[DeclarativeReportTemplate]**](DeclarativeReportTemplate.md) | A list of report templates available in the model. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeColumn.md b/gooddata-api-client/docs/DeclarativeColumn.md index bbd7b29d3..ef570f9b2 100644 --- a/gooddata-api-client/docs/DeclarativeColumn.md +++ b/gooddata-api-client/docs/DeclarativeColumn.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data_type** | **str** | Column type | **name** | **str** | Column name. Must not contain NUL (0x00) characters. | +**default_label_of** | **str** | (EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column. | [optional] **description** | **str** | Column description/comment from database | [optional] **is_nullable** | **bool** | Column is nullable | [optional] **is_primary_key** | **bool** | Is column part of primary key? | [optional] diff --git a/gooddata-api-client/docs/DeclarativeDataSource.md b/gooddata-api-client/docs/DeclarativeDataSource.md index f6f9d560d..cac69ad12 100644 --- a/gooddata-api-client/docs/DeclarativeDataSource.md +++ b/gooddata-api-client/docs/DeclarativeDataSource.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **date_time_semantics** | **str, none_type** | Determines how datetime values are interpreted in data sources without native support for specifying this. - LOCAL: The values are assumed to be in local timezone and they are not converted to the user's timezone. - UTC: The values are assumed to be in UTC and they are converted to the user's timezone. | [optional] **decoded_parameters** | [**[Parameter]**](Parameter.md) | | [optional] **disable_statistics** | **bool, none_type** | Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset. | [optional] +**ignore_jwt_aud** | **bool, none_type** | Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it. | [optional] **parameters** | [**[Parameter]**](Parameter.md) | | [optional] **password** | **str** | Password for the data-source user, property is never returned back. | [optional] **permissions** | [**[DeclarativeDataSourcePermission]**](DeclarativeDataSourcePermission.md) | | [optional] diff --git a/gooddata-api-client/docs/DeclarativeMetric.md b/gooddata-api-client/docs/DeclarativeMetric.md index fa04e12e0..9b155a03b 100644 --- a/gooddata-api-client/docs/DeclarativeMetric.md +++ b/gooddata-api-client/docs/DeclarativeMetric.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **is_hidden_from_kda** | **bool** | If true, this metric is hidden from key drive analysis. | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**permissions** | [**[DeclarativeMetricPermissionsInner], none_type**](DeclarativeMetricPermissionsInner.md) | A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them. | [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/DeclarativeMetricPermissionAssignment.md b/gooddata-api-client/docs/DeclarativeMetricPermissionAssignment.md new file mode 100644 index 000000000..391e08697 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeMetricPermissionAssignment.md @@ -0,0 +1,13 @@ +# DeclarativeMetricPermissionAssignment + +Metric permission. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**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/DeclarativeMetricPermissionForAssignee.md b/gooddata-api-client/docs/DeclarativeMetricPermissionForAssignee.md new file mode 100644 index 000000000..9e19de1b9 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeMetricPermissionForAssignee.md @@ -0,0 +1,14 @@ +# DeclarativeMetricPermissionForAssignee + +Metric permission for an assignee. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**assignee** | [**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/DeclarativeMetricPermissionForAssigneeRule.md b/gooddata-api-client/docs/DeclarativeMetricPermissionForAssigneeRule.md new file mode 100644 index 000000000..1ed08099a --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeMetricPermissionForAssigneeRule.md @@ -0,0 +1,14 @@ +# DeclarativeMetricPermissionForAssigneeRule + +Metric permission for a collection of assignees identified by a rule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**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/DeclarativeMetricPermissionsInner.md b/gooddata-api-client/docs/DeclarativeMetricPermissionsInner.md new file mode 100644 index 000000000..ece96b1c7 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeMetricPermissionsInner.md @@ -0,0 +1,14 @@ +# DeclarativeMetricPermissionsInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | [optional] +**assignee** | [**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/DeclarativePublisherDocument.md b/gooddata-api-client/docs/DeclarativePublisherDocument.md new file mode 100644 index 000000000..3f17b53b1 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativePublisherDocument.md @@ -0,0 +1,18 @@ +# DeclarativePublisherDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**PublisherDocumentContent**](PublisherDocumentContent.md) | | +**id** | **str** | Document ID. | +**period** | [**PublisherDocumentPeriod**](PublisherDocumentPeriod.md) | | +**title** | **str** | Document title. | +**version** | **str** | Version of the content format. | +**description** | **str** | Document description. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md b/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md new file mode 100644 index 000000000..58d71c1d4 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativePublisherDocumentPageTemplate.md @@ -0,0 +1,17 @@ +# DeclarativePublisherDocumentPageTemplate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**PublisherDocumentPageTemplateContent**](PublisherDocumentPageTemplateContent.md) | | +**id** | **str** | Page template ID. | +**title** | **str** | Page template title. | +**version** | **str** | Version of the content format. | +**description** | **str** | Page template description. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/DeclarativePublisherDocumentTemplate.md b/gooddata-api-client/docs/DeclarativePublisherDocumentTemplate.md new file mode 100644 index 000000000..9dbf99880 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativePublisherDocumentTemplate.md @@ -0,0 +1,17 @@ +# DeclarativePublisherDocumentTemplate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**PublisherDocumentContent**](PublisherDocumentContent.md) | | +**id** | **str** | Document template ID. | +**title** | **str** | Document template title. | +**version** | **str** | Version of the content format. | +**description** | **str** | Document template description. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/DeclarativeTable.md b/gooddata-api-client/docs/DeclarativeTable.md index c8f725e84..6a574f66b 100644 --- a/gooddata-api-client/docs/DeclarativeTable.md +++ b/gooddata-api-client/docs/DeclarativeTable.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **path** | **[str]** | Path to table. | **type** | **str** | Table type: TABLE or VIEW. | **name_prefix** | **str** | Table or view name prefix used in scan. Will be stripped when generating LDM. | [optional] +**properties** | **{str: (str,)}** | Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys. | [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/DeclarativeVisualizationObject.md b/gooddata-api-client/docs/DeclarativeVisualizationObject.md index 9db8ab3b2..c75433b3c 100644 --- a/gooddata-api-client/docs/DeclarativeVisualizationObject.md +++ b/gooddata-api-client/docs/DeclarativeVisualizationObject.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **is_hidden** | **bool** | If true, this visualization object is hidden from AI search results. | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**permissions** | [**[DeclarativeVisualizationObjectPermissionsInner], none_type**](DeclarativeVisualizationObjectPermissionsInner.md) | A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them. | [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/DeclarativeVisualizationObjectPermissionAssignment.md b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionAssignment.md new file mode 100644 index 000000000..9d1fe309e --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionAssignment.md @@ -0,0 +1,13 @@ +# DeclarativeVisualizationObjectPermissionAssignment + +Visualization object permission. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**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/DeclarativeVisualizationObjectPermissionForAssignee.md b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionForAssignee.md new file mode 100644 index 000000000..01ef5a3ba --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionForAssignee.md @@ -0,0 +1,14 @@ +# DeclarativeVisualizationObjectPermissionForAssignee + +Visualization object permission for an assignee. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**assignee** | [**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/DeclarativeVisualizationObjectPermissionForAssigneeRule.md b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md new file mode 100644 index 000000000..b1ad2029e --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionForAssigneeRule.md @@ -0,0 +1,14 @@ +# DeclarativeVisualizationObjectPermissionForAssigneeRule + +Visualization object permission for a collection of assignees identified by a rule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | +**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/DeclarativeVisualizationObjectPermissionsInner.md b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionsInner.md new file mode 100644 index 000000000..d01bdb663 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeVisualizationObjectPermissionsInner.md @@ -0,0 +1,14 @@ +# DeclarativeVisualizationObjectPermissionsInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Permission name. | [optional] +**assignee** | [**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/DocumentControllerApi.md b/gooddata-api-client/docs/DocumentControllerApi.md new file mode 100644 index 000000000..50d4aa2d7 --- /dev/null +++ b/gooddata-api-client/docs/DocumentControllerApi.md @@ -0,0 +1,998 @@ +# gooddata_api_client.DocumentControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_documents**](DocumentControllerApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document +[**delete_entity_documents**](DocumentControllerApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document +[**get_all_entities_documents**](DocumentControllerApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents +[**get_entity_documents**](DocumentControllerApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document +[**patch_entity_documents**](DocumentControllerApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +[**update_entity_documents**](DocumentControllerApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document + + +# **create_entity_documents** +> JsonApiPublisherDocumentOutDocument create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + +Post Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_post_optional_id_document = JsonApiPublisherDocumentPostOptionalIdDocument( + data=JsonApiPublisherDocumentPostOptionalId( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentPostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->create_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->create_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_post_optional_id_document** | [**JsonApiPublisherDocumentPostOptionalIdDocument**](JsonApiPublisherDocumentPostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_documents** +> delete_entity_documents(workspace_id, object_id) + +Delete a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_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 = document_controller_api.DocumentControllerApi(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 Document + api_instance.delete_entity_documents(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->delete_entity_documents: %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_documents** +> JsonApiPublisherDocumentOutList get_all_entities_documents(workspace_id) + +Get all Documents + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Documents + api_response = api_instance.get_all_entities_documents(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->get_all_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Documents + api_response = api_instance.get_all_entities_documents(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 DocumentControllerApi->get_all_entities_documents: %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] + **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 + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.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_documents** +> JsonApiPublisherDocumentOutDocument get_entity_documents(workspace_id, object_id) + +Get a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Document + api_response = api_instance.get_entity_documents(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->get_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document + api_response = api_instance.get_entity_documents(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 DocumentControllerApi->get_entity_documents: %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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) + +Patch a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_patch_document = JsonApiPublisherDocumentPatchDocument( + data=JsonApiPublisherDocumentPatch( + attributes=JsonApiPublisherDocumentPatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentPatchDocument | + filter = "version==someString;title==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 a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->patch_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->patch_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_patch_document** | [**JsonApiPublisherDocumentPatchDocument**](JsonApiPublisherDocumentPatchDocument.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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) + +Put a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_controller_api +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_controller_api.DocumentControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_in_document = JsonApiPublisherDocumentInDocument( + data=JsonApiPublisherDocumentIn( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentInDocument | + filter = "version==someString;title==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 a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->update_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentControllerApi->update_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_in_document** | [**JsonApiPublisherDocumentInDocument**](JsonApiPublisherDocumentInDocument.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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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/DocumentTemplateControllerApi.md b/gooddata-api-client/docs/DocumentTemplateControllerApi.md new file mode 100644 index 000000000..809fbfa5b --- /dev/null +++ b/gooddata-api-client/docs/DocumentTemplateControllerApi.md @@ -0,0 +1,995 @@ +# gooddata_api_client.DocumentTemplateControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_document_templates**](DocumentTemplateControllerApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +[**delete_entity_document_templates**](DocumentTemplateControllerApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +[**get_all_entities_document_templates**](DocumentTemplateControllerApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +[**get_entity_document_templates**](DocumentTemplateControllerApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +[**patch_entity_document_templates**](DocumentTemplateControllerApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +[**update_entity_document_templates**](DocumentTemplateControllerApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template + + +# **create_entity_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + +Post Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_template_controller_api.DocumentTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_template_post_optional_id_document = JsonApiPublisherDocumentTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->create_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->create_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_template_post_optional_id_document** | [**JsonApiPublisherDocumentTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_document_templates** +> delete_entity_document_templates(workspace_id, object_id) + +Delete a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_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 = document_template_controller_api.DocumentTemplateControllerApi(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 Document Template + api_instance.delete_entity_document_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->delete_entity_document_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_document_templates** +> JsonApiPublisherDocumentTemplateOutList get_all_entities_document_templates(workspace_id) + +Get all Document Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_template_controller_api.DocumentTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Document Templates + api_response = api_instance.get_all_entities_document_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->get_all_entities_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Document Templates + api_response = api_instance.get_all_entities_document_templates(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 DocumentTemplateControllerApi->get_all_entities_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutList**](JsonApiPublisherDocumentTemplateOutList.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument get_entity_document_templates(workspace_id, object_id) + +Get a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_template_controller_api.DocumentTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->get_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(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 DocumentTemplateControllerApi->get_entity_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) + +Patch a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_template_controller_api.DocumentTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_template_patch_document = JsonApiPublisherDocumentTemplatePatchDocument( + data=JsonApiPublisherDocumentTemplatePatch( + attributes=JsonApiPublisherDocumentTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplatePatchDocument | + filter = "version==someString;title==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 a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->patch_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->patch_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_template_patch_document** | [**JsonApiPublisherDocumentTemplatePatchDocument**](JsonApiPublisherDocumentTemplatePatchDocument.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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) + +Put a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import document_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = document_template_controller_api.DocumentTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_template_in_document = JsonApiPublisherDocumentTemplateInDocument( + data=JsonApiPublisherDocumentTemplateIn( + attributes=JsonApiPublisherDocumentTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplateInDocument | + filter = "version==someString;title==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 a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->update_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling DocumentTemplateControllerApi->update_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_template_in_document** | [**JsonApiPublisherDocumentTemplateInDocument**](JsonApiPublisherDocumentTemplateInDocument.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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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/ElementsResponse.md b/gooddata-api-client/docs/ElementsResponse.md index aafc8bcdf..1bd3506e4 100644 --- a/gooddata-api-client/docs/ElementsResponse.md +++ b/gooddata-api-client/docs/ElementsResponse.md @@ -9,8 +9,10 @@ Name | Type | Description | Notes **paging** | [**Paging**](Paging.md) | | **primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | | **cache_id** | **str** | The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself. | [optional] +**data_type** | **str** | Data type of the element values, only filled for computed attributes. | [optional] **format** | [**AttributeFormat**](AttributeFormat.md) | | [optional] **granularity** | **str** | Granularity of requested label in case of date attribute | [optional] +**number_format** | **str** | Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format. | [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/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 4a6cbad47..ddec52f99 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -18,6 +18,8 @@ Method | HTTP request | Description [**create_entity_custom_user_application_settings**](EntitiesApi.md#create_entity_custom_user_application_settings) | **POST** /api/v1/entities/users/{userId}/customUserApplicationSettings | Post a new custom application setting for the user [**create_entity_dashboard_plugins**](EntitiesApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins [**create_entity_data_sources**](EntitiesApi.md#create_entity_data_sources) | **POST** /api/v1/entities/dataSources | Post Data Sources +[**create_entity_document_templates**](EntitiesApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +[**create_entity_documents**](EntitiesApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document [**create_entity_export_definitions**](EntitiesApi.md#create_entity_export_definitions) | **POST** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Post Export Definitions [**create_entity_export_templates**](EntitiesApi.md#create_entity_export_templates) | **POST** /api/v1/entities/exportTemplates | Post Export Template entities [**create_entity_filter_contexts**](EntitiesApi.md#create_entity_filter_contexts) | **POST** /api/v1/entities/workspaces/{workspaceId}/filterContexts | Post Filter Context @@ -32,6 +34,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template [**create_entity_parameters**](EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters [**create_entity_report_page_layouts**](EntitiesApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout [**create_entity_report_templates**](EntitiesApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template @@ -63,6 +66,8 @@ Method | HTTP request | Description [**delete_entity_custom_user_application_settings**](EntitiesApi.md#delete_entity_custom_user_application_settings) | **DELETE** /api/v1/entities/users/{userId}/customUserApplicationSettings/{id} | Delete a custom application setting for a user [**delete_entity_dashboard_plugins**](EntitiesApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin [**delete_entity_data_sources**](EntitiesApi.md#delete_entity_data_sources) | **DELETE** /api/v1/entities/dataSources/{id} | Delete Data Source entity +[**delete_entity_document_templates**](EntitiesApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +[**delete_entity_documents**](EntitiesApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document [**delete_entity_export_definitions**](EntitiesApi.md#delete_entity_export_definitions) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Delete an Export Definition [**delete_entity_export_templates**](EntitiesApi.md#delete_entity_export_templates) | **DELETE** /api/v1/entities/exportTemplates/{id} | Delete Export Template entity [**delete_entity_filter_contexts**](EntitiesApi.md#delete_entity_filter_contexts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Delete a Filter Context @@ -77,6 +82,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template [**delete_entity_parameters**](EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter [**delete_entity_report_page_layouts**](EntitiesApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout [**delete_entity_report_templates**](EntitiesApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template @@ -113,6 +119,8 @@ Method | HTTP request | Description [**get_all_entities_data_source_identifiers**](EntitiesApi.md#get_all_entities_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers | Get all Data Source Identifiers [**get_all_entities_data_sources**](EntitiesApi.md#get_all_entities_data_sources) | **GET** /api/v1/entities/dataSources | Get Data Source entities [**get_all_entities_datasets**](EntitiesApi.md#get_all_entities_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets | Get all Datasets +[**get_all_entities_document_templates**](EntitiesApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +[**get_all_entities_documents**](EntitiesApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents [**get_all_entities_entitlements**](EntitiesApi.md#get_all_entities_entitlements) | **GET** /api/v1/entities/entitlements | Get Entitlements [**get_all_entities_export_definitions**](EntitiesApi.md#get_all_entities_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions | Get all Export Definitions [**get_all_entities_export_templates**](EntitiesApi.md#get_all_entities_export_templates) | **GET** /api/v1/entities/exportTemplates | GET all Export Template entities @@ -132,6 +140,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates [**get_all_entities_parameters**](EntitiesApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters [**get_all_entities_report_page_layouts**](EntitiesApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts [**get_all_entities_report_templates**](EntitiesApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates @@ -171,6 +180,8 @@ Method | HTTP request | Description [**get_entity_data_source_identifiers**](EntitiesApi.md#get_entity_data_source_identifiers) | **GET** /api/v1/entities/dataSourceIdentifiers/{id} | Get Data Source Identifier [**get_entity_data_sources**](EntitiesApi.md#get_entity_data_sources) | **GET** /api/v1/entities/dataSources/{id} | Get Data Source entity [**get_entity_datasets**](EntitiesApi.md#get_entity_datasets) | **GET** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Get a Dataset +[**get_entity_document_templates**](EntitiesApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +[**get_entity_documents**](EntitiesApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document [**get_entity_entitlements**](EntitiesApi.md#get_entity_entitlements) | **GET** /api/v1/entities/entitlements/{id} | Get Entitlement entity [**get_entity_export_definitions**](EntitiesApi.md#get_entity_export_definitions) | **GET** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Get an Export Definition [**get_entity_export_templates**](EntitiesApi.md#get_entity_export_templates) | **GET** /api/v1/entities/exportTemplates/{id} | GET Export Template entity @@ -191,6 +202,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template [**get_entity_parameters**](EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter [**get_entity_report_page_layouts**](EntitiesApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout [**get_entity_report_templates**](EntitiesApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template @@ -225,6 +237,8 @@ Method | HTTP request | Description [**patch_entity_dashboard_plugins**](EntitiesApi.md#patch_entity_dashboard_plugins) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Patch a Plugin [**patch_entity_data_sources**](EntitiesApi.md#patch_entity_data_sources) | **PATCH** /api/v1/entities/dataSources/{id} | Patch Data Source entity [**patch_entity_datasets**](EntitiesApi.md#patch_entity_datasets) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId} | Patch a Dataset (beta) +[**patch_entity_document_templates**](EntitiesApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +[**patch_entity_documents**](EntitiesApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document [**patch_entity_export_definitions**](EntitiesApi.md#patch_entity_export_definitions) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Patch an Export Definition [**patch_entity_export_templates**](EntitiesApi.md#patch_entity_export_templates) | **PATCH** /api/v1/entities/exportTemplates/{id} | Patch Export Template entity [**patch_entity_facts**](EntitiesApi.md#patch_entity_facts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/facts/{objectId} | Patch a Fact (beta) @@ -241,6 +255,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template [**patch_entity_parameters**](EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter [**patch_entity_report_page_layouts**](EntitiesApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout [**patch_entity_report_templates**](EntitiesApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template @@ -295,6 +310,8 @@ Method | HTTP request | Description [**update_entity_custom_user_application_settings**](EntitiesApi.md#update_entity_custom_user_application_settings) | **PUT** /api/v1/entities/users/{userId}/customUserApplicationSettings/{id} | Put a custom application setting for the user [**update_entity_dashboard_plugins**](EntitiesApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin [**update_entity_data_sources**](EntitiesApi.md#update_entity_data_sources) | **PUT** /api/v1/entities/dataSources/{id} | Put Data Source entity +[**update_entity_document_templates**](EntitiesApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template +[**update_entity_documents**](EntitiesApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document [**update_entity_export_definitions**](EntitiesApi.md#update_entity_export_definitions) | **PUT** /api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId} | Put an Export Definition [**update_entity_export_templates**](EntitiesApi.md#update_entity_export_templates) | **PUT** /api/v1/entities/exportTemplates/{id} | PUT Export Template entity [**update_entity_filter_contexts**](EntitiesApi.md#update_entity_filter_contexts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId} | Put a Filter Context @@ -310,6 +327,7 @@ Method | HTTP request | Description [**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_page_templates**](EntitiesApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template [**update_entity_parameters**](EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter [**update_entity_report_page_layouts**](EntitiesApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout [**update_entity_report_templates**](EntitiesApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template @@ -1854,6 +1872,7 @@ with gooddata_api_client.ApiClient() as api_client: client_secret="client_secret_example", date_time_semantics="LOCAL", disable_statistics=True, + ignore_jwt_aud=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -1918,6 +1937,495 @@ 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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + +Post Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument +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_publisher_document_template_post_optional_id_document = JsonApiPublisherDocumentTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_template_post_optional_id_document** | [**JsonApiPublisherDocumentTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + +Post Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +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_publisher_document_post_optional_id_document = JsonApiPublisherDocumentPostOptionalIdDocument( + data=JsonApiPublisherDocumentPostOptionalId( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentPostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_post_optional_id_document** | [**JsonApiPublisherDocumentPostOptionalIdDocument**](JsonApiPublisherDocumentPostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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 | @@ -3322,6 +3830,145 @@ 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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + +Post Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +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_publisher_document_page_template_post_optional_id_document = JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentPageTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_page_template_post_optional_id_document** | [**JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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 | @@ -5951,6 +6598,136 @@ 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_document_templates** +> delete_entity_document_templates(workspace_id, object_id) + +Delete a Document Template + +### 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 Document Template + api_instance.delete_entity_document_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_document_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_documents** +> delete_entity_documents(workspace_id, object_id) + +Delete a Document + +### 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 Document + api_instance.delete_entity_documents(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_documents: %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 | @@ -6795,7 +7572,70 @@ No authorization required # **delete_entity_organization_settings** > delete_entity_organization_settings(id) -Delete Organization Setting entity +Delete Organization Setting 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 Organization Setting entity + api_instance.delete_entity_organization_settings(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->delete_entity_organization_settings: %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_page_templates** +> delete_entity_page_templates(workspace_id, object_id) + +Delete a Page Template ### Example @@ -6816,14 +7656,15 @@ 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 Organization Setting entity - api_instance.delete_entity_organization_settings(id) + # Delete a Page Template + api_instance.delete_entity_page_templates(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_page_templates: %s\n" % e) ``` @@ -6831,7 +7672,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -9605,6 +10447,198 @@ 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_document_templates** +> JsonApiPublisherDocumentTemplateOutList get_all_entities_document_templates(workspace_id) + +Get all Document Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +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 | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Document Templates + api_response = api_instance.get_all_entities_document_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Document Templates + api_response = api_instance.get_all_entities_document_templates(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_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutList**](JsonApiPublisherDocumentTemplateOutList.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_documents** +> JsonApiPublisherDocumentOutList get_all_entities_documents(workspace_id) + +Get all Documents + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from 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 | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Documents + api_response = api_instance.get_all_entities_documents(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Documents + api_response = api_instance.get_all_entities_documents(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_documents: %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] + **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 + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.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 | @@ -11167,7 +12201,85 @@ Name | Type | Description | Notes ### Return type -[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) +[**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_all_entities_organization_settings** +> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() + +Get Organization Setting entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +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==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) + 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 Organization Setting entities + api_response = api_instance.get_all_entities_organization_settings(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_organization_settings: %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 + +[**JsonApiOrganizationSettingOutList**](JsonApiOrganizationSettingOutList.md) ### Authorization @@ -11187,10 +12299,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_organization_settings** -> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() +# **get_all_entities_page_templates** +> JsonApiPublisherDocumentPageTemplateOutList get_all_entities_page_templates(workspace_id) -Get Organization Setting entities +Get all Page Templates ### Example @@ -11199,7 +12311,7 @@ Get Organization Setting entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_list import JsonApiOrganizationSettingOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList 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. @@ -11212,24 +12324,38 @@ 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==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) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=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 Page Templates + api_response = api_instance.get_all_entities_page_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_page_templates: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get Organization Setting entities - api_response = api_instance.get_all_entities_organization_settings(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Page Templates + api_response = api_instance.get_all_entities_page_templates(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_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_page_templates: %s\n" % e) ``` @@ -11237,15 +12363,19 @@ 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 -[**JsonApiOrganizationSettingOutList**](JsonApiOrganizationSettingOutList.md) +[**JsonApiPublisherDocumentPageTemplateOutList**](JsonApiPublisherDocumentPageTemplateOutList.md) ### Authorization @@ -14572,6 +15702,182 @@ 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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument get_entity_document_templates(workspace_id, object_id) + +Get a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +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 = "version==someString;title==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: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(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_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument get_entity_documents(workspace_id, object_id) + +Get a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +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 = "version==someString;title==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: + # Get a Document + api_response = api_instance.get_entity_documents(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document + api_response = api_instance.get_entity_documents(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_documents: %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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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 | @@ -16082,24 +17388,106 @@ 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 = "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 = "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: + # Get Organization Setting entity + api_response = api_instance.get_entity_organization_settings(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Organization Setting entity + api_response = api_instance.get_entity_organization_settings(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_organization_settings: %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 + +[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.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_organizations** +> JsonApiOrganizationOutDocument get_entity_organizations(id) + +Get Organizations + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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 = [ + "bootstrapUser,bootstrapUserGroup,identityProvider", + ] # [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=permissions,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Organization Setting entity - api_response = api_instance.get_entity_organization_settings(id) + # Get Organizations + api_response = api_instance.get_entity_organizations(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Organization Setting entity - api_response = api_instance.get_entity_organization_settings(id, filter=filter) + # Get Organizations + api_response = api_instance.get_entity_organizations(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_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) ``` @@ -16109,10 +17497,12 @@ 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 -[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.md) +[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) ### Authorization @@ -16132,10 +17522,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_organizations** -> JsonApiOrganizationOutDocument get_entity_organizations(id) +# **get_entity_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument get_entity_page_templates(workspace_id, object_id) -Get Organizations +Get a Page Template ### Example @@ -16144,7 +17534,7 @@ Get Organizations import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument 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. @@ -16157,31 +17547,33 @@ 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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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 = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", + "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=permissions,all", + "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id) + # Get a Page Template + api_response = api_instance.get_entity_page_templates(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_page_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) + # Get a Page Template + api_response = api_instance.get_entity_page_templates(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_organizations: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_page_templates: %s\n" % e) ``` @@ -16189,14 +17581,16 @@ 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 -[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.md) ### Authorization @@ -19295,7 +20689,218 @@ No authorization required # **patch_entity_dashboard_plugins** > JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) -Patch a Plugin +Patch a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +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_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( + data=JsonApiDashboardPluginPatch( + attributes=JsonApiDashboardPluginInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dashboardPlugin", + ), + ) # JsonApiDashboardPluginPatchDocument | + 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 a Plugin + api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Plugin + api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.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 + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.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_data_sources** +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) + +Patch Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +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_data_source_patch_document = JsonApiDataSourcePatchDocument( + 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", + date_time_semantics="LOCAL", + disable_statistics=True, + ignore_jwt_aud=True, + name="name_example", + parameters=[ + JsonApiDataSourceInAttributesParametersInner( + name="name_example", + value="value_example", + ), + ], + password="password_example", + private_key="private_key_example", + private_key_passphrase="private_key_passphrase_example", + schema="schema_example", + token="token_example", + type="POSTGRESQL", + url="url_example", + username="username_example", + ), + id="id1", + type="dataSource", + ), + ) # JsonApiDataSourcePatchDocument | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 Data Source entity + api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Data Source entity + api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.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 + +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.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_datasets** +> JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) + +Patch a Dataset (beta) ### Example @@ -19304,8 +20909,8 @@ Patch a Plugin import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_patch_document import JsonApiDashboardPluginPatchDocument +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument +from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument 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. @@ -19320,11 +20925,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 | - json_api_dashboard_plugin_patch_document = JsonApiDashboardPluginPatchDocument( - data=JsonApiDashboardPluginPatch( - attributes=JsonApiDashboardPluginInAttributes( - are_relations_valid=True, - content={}, + json_api_dataset_patch_document = JsonApiDatasetPatchDocument( + data=JsonApiDatasetPatch( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", @@ -19332,30 +20935,30 @@ with gooddata_api_client.ApiClient() as api_client: title="title_example", ), id="id1", - type="dashboardPlugin", + type="dataset", ), - ) # JsonApiDashboardPluginPatchDocument | - 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) + ) # JsonApiDatasetPatchDocument | + 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 = [ - "createdBy,modifiedBy", + "attributes,facts,aggregatedFacts,references,workspaceDataFilters", ] # [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 Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) + # Patch a Dataset (beta) + api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Plugin - api_response = api_instance.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, filter=filter, include=include) + # Patch a Dataset (beta) + api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) ``` @@ -19365,13 +20968,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **json_api_dataset_patch_document** | [**JsonApiDatasetPatchDocument**](JsonApiDatasetPatchDocument.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 -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) +[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) ### Authorization @@ -19391,12 +20994,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_data_sources** -> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) - -Patch Data Source entity +# **patch_entity_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) -Data Source - represents data source for the workspace +Patch a Document Template ### Example @@ -19405,8 +21006,8 @@ Data Source - represents data source for the workspace import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument 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. @@ -19419,56 +21020,189 @@ 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 | - json_api_data_source_patch_document = JsonApiDataSourcePatchDocument( - 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", - date_time_semantics="LOCAL", - disable_statistics=True, - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_template_patch_document = JsonApiPublisherDocumentTemplatePatchDocument( + data=JsonApiPublisherDocumentTemplatePatch( + attributes=JsonApiPublisherDocumentTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), ), + ), + description="description_example", + tags=[ + "tags_example", ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", + title="title_example", + version="2", ), id="id1", - type="dataSource", + type="documentTemplate", ), - ) # JsonApiDataSourcePatchDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiPublisherDocumentTemplatePatchDocument | + filter = "version==someString;title==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 Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document) + # Patch a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_document_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Data Source entity - api_response = api_instance.patch_entity_data_sources(id, json_api_data_source_patch_document, filter=filter) + # Patch a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_document_templates: %s\n" % e) ``` @@ -19476,13 +21210,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_template_patch_document** | [**JsonApiPublisherDocumentTemplatePatchDocument**](JsonApiPublisherDocumentTemplatePatchDocument.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 -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.md) ### Authorization @@ -19502,10 +21238,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_datasets** -> JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) +# **patch_entity_documents** +> JsonApiPublisherDocumentOutDocument patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) -Patch a Dataset (beta) +Patch a Document ### Example @@ -19514,8 +21250,8 @@ Patch a Dataset (beta) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument -from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument 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. @@ -19530,40 +21266,188 @@ 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_dataset_patch_document = JsonApiDatasetPatchDocument( - data=JsonApiDatasetPatch( - attributes=JsonApiDatasetPatchAttributes( + json_api_publisher_document_patch_document = JsonApiPublisherDocumentPatchDocument( + data=JsonApiPublisherDocumentPatch( + attributes=JsonApiPublisherDocumentPatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), tags=[ "tags_example", ], title="title_example", + version="2", ), id="id1", - type="dataset", + type="document", ), - ) # JsonApiDatasetPatchDocument | - 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) + ) # JsonApiPublisherDocumentPatchDocument | + filter = "version==someString;title==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 = [ - "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "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 a Dataset (beta) - api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) + # Patch a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_documents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Dataset (beta) - api_response = api_instance.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, filter=filter, include=include) + # Patch a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_documents: %s\n" % e) ``` @@ -19573,13 +21457,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_dataset_patch_document** | [**JsonApiDatasetPatchDocument**](JsonApiDatasetPatchDocument.md)| | + **json_api_publisher_document_patch_document** | [**JsonApiPublisherDocumentPatchDocument**](JsonApiPublisherDocumentPatchDocument.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 -[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.md) ### Authorization @@ -21144,16 +23028,119 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Organization Setting entity + api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.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 + +[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.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_organizations** +> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) + +Patch Organization + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument +from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +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_organization_patch_document = JsonApiOrganizationPatchDocument( + data=JsonApiOrganizationPatch( + attributes=JsonApiOrganizationInAttributes( + allowed_origins=[ + "allowed_origins_example", + ], + early_access="early_access_example", + early_access_values=[ + "early_access_values_example", + ], + hostname="hostname_example", + name="name_example", + ), + id="id1", + relationships=JsonApiOrganizationInRelationships( + identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( + data=JsonApiIdentityProviderToOneLinkage(None), + ), + ), + type="organization", + ), + ) # JsonApiOrganizationPatchDocument | + filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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 = [ + "bootstrapUser,bootstrapUserGroup,identityProvider", + ] # [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 Organization + api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Organization Setting entity - api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, filter=filter) + # Patch Organization + api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) ``` @@ -21162,12 +23149,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | + **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.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 -[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.md) +[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) ### Authorization @@ -21187,10 +23175,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_organizations** -> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) +# **patch_entity_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) -Patch Organization +Patch a Page Template ### Example @@ -21199,8 +23187,8 @@ Patch Organization import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_out_document import JsonApiOrganizationOutDocument -from gooddata_api_client.model.json_api_organization_patch_document import JsonApiOrganizationPatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument 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. @@ -21213,50 +23201,84 @@ 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 | - json_api_organization_patch_document = JsonApiOrganizationPatchDocument( - data=JsonApiOrganizationPatch( - attributes=JsonApiOrganizationInAttributes( - allowed_origins=[ - "allowed_origins_example", - ], - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_page_template_patch_document = JsonApiPublisherDocumentPageTemplatePatchDocument( + data=JsonApiPublisherDocumentPageTemplatePatch( + attributes=JsonApiPublisherDocumentPageTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", ], - hostname="hostname_example", - name="name_example", + title="title_example", + version="2", ), id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", + type="pageTemplate", ), - ) # JsonApiOrganizationPatchDocument | - filter = "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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) + ) # JsonApiPublisherDocumentPageTemplatePatchDocument | + filter = "version==someString;title==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 = [ - "bootstrapUser,bootstrapUserGroup,identityProvider", + "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 Organization - api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document) + # Patch a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_page_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Organization - api_response = api_instance.patch_entity_organizations(id, json_api_organization_patch_document, filter=filter, include=include) + # Patch a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_page_templates: %s\n" % e) ``` @@ -21264,14 +23286,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_patch_document** | [**JsonApiOrganizationPatchDocument**](JsonApiOrganizationPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_patch_document** | [**JsonApiPublisherDocumentPageTemplatePatchDocument**](JsonApiPublisherDocumentPageTemplatePatchDocument.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 -[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.md) ### Authorization @@ -26717,8 +28740,200 @@ Put a custom application setting for the user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_user_application_setting_out_document import JsonApiCustomUserApplicationSettingOutDocument -from gooddata_api_client.model.json_api_custom_user_application_setting_in_document import JsonApiCustomUserApplicationSettingInDocument +from gooddata_api_client.model.json_api_custom_user_application_setting_out_document import JsonApiCustomUserApplicationSettingOutDocument +from gooddata_api_client.model.json_api_custom_user_application_setting_in_document import JsonApiCustomUserApplicationSettingInDocument +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) + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + json_api_custom_user_application_setting_in_document = JsonApiCustomUserApplicationSettingInDocument( + data=JsonApiCustomUserApplicationSettingIn( + attributes=JsonApiCustomUserApplicationSettingInAttributes( + application_name="application_name_example", + content={}, + workspace_id="workspace_id_example", + ), + id="id1", + type="customUserApplicationSetting", + ), + ) # JsonApiCustomUserApplicationSettingInDocument | + filter = "applicationName==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 custom application setting for the user + api_response = api_instance.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_custom_user_application_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a custom application setting for the user + api_response = api_instance.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_custom_user_application_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | + **id** | **str**| | + **json_api_custom_user_application_setting_in_document** | [**JsonApiCustomUserApplicationSettingInDocument**](JsonApiCustomUserApplicationSettingInDocument.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 + +[**JsonApiCustomUserApplicationSettingOutDocument**](JsonApiCustomUserApplicationSettingOutDocument.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_dashboard_plugins** +> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) + +Put a Plugin + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +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_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( + data=JsonApiDashboardPluginIn( + attributes=JsonApiDashboardPluginInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="dashboardPlugin", + ), + ) # JsonApiDashboardPluginInDocument | + 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 a Plugin + api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Plugin + api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.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 + +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.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_data_sources** +> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) + +Put Data Source entity + +Data Source - represents data source for the workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument +from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument 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. @@ -26731,37 +28946,57 @@ 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) - user_id = "userId_example" # str | id = "/6bUUGjjNSwg0_bs" # str | - json_api_custom_user_application_setting_in_document = JsonApiCustomUserApplicationSettingInDocument( - data=JsonApiCustomUserApplicationSettingIn( - attributes=JsonApiCustomUserApplicationSettingInAttributes( - application_name="application_name_example", - content={}, - workspace_id="workspace_id_example", + json_api_data_source_in_document = JsonApiDataSourceInDocument( + 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", + date_time_semantics="LOCAL", + disable_statistics=True, + ignore_jwt_aud=True, + name="name_example", + parameters=[ + JsonApiDataSourceInAttributesParametersInner( + name="name_example", + value="value_example", + ), + ], + password="password_example", + private_key="private_key_example", + private_key_passphrase="private_key_passphrase_example", + schema="schema_example", + token="token_example", + type="POSTGRESQL", + url="url_example", + username="username_example", ), id="id1", - type="customUserApplicationSetting", + type="dataSource", ), - ) # JsonApiCustomUserApplicationSettingInDocument | - filter = "applicationName==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) + ) # JsonApiDataSourceInDocument | + filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 custom application setting for the user - api_response = api_instance.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document) + # Put Data Source entity + api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a custom application setting for the user - api_response = api_instance.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, filter=filter) + # Put Data Source entity + api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) ``` @@ -26769,14 +29004,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | **id** | **str**| | - **json_api_custom_user_application_setting_in_document** | [**JsonApiCustomUserApplicationSettingInDocument**](JsonApiCustomUserApplicationSettingInDocument.md)| | + **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.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 -[**JsonApiCustomUserApplicationSettingOutDocument**](JsonApiCustomUserApplicationSettingOutDocument.md) +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) ### Authorization @@ -26796,10 +29030,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_dashboard_plugins** -> JsonApiDashboardPluginOutDocument update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) +# **update_entity_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) -Put a Plugin +Put a Document Template ### Example @@ -26808,8 +29042,8 @@ Put a Plugin import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument -from gooddata_api_client.model.json_api_dashboard_plugin_in_document import JsonApiDashboardPluginInDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument 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. @@ -26824,42 +29058,187 @@ 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_dashboard_plugin_in_document = JsonApiDashboardPluginInDocument( - data=JsonApiDashboardPluginIn( - attributes=JsonApiDashboardPluginInAttributes( + json_api_publisher_document_template_in_document = JsonApiPublisherDocumentTemplateInDocument( + data=JsonApiPublisherDocumentTemplateIn( + attributes=JsonApiPublisherDocumentTemplateInAttributes( are_relations_valid=True, - content={}, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), description="description_example", tags=[ "tags_example", ], title="title_example", + version="2", ), id="id1", - type="dashboardPlugin", + type="documentTemplate", ), - ) # JsonApiDashboardPluginInDocument | - 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) + ) # JsonApiPublisherDocumentTemplateInDocument | + filter = "version==someString;title==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 a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document) + # Put a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_document_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Plugin - api_response = api_instance.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, filter=filter, include=include) + # Put a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_document_templates: %s\n" % e) ``` @@ -26869,13 +29248,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_dashboard_plugin_in_document** | [**JsonApiDashboardPluginInDocument**](JsonApiDashboardPluginInDocument.md)| | + **json_api_publisher_document_template_in_document** | [**JsonApiPublisherDocumentTemplateInDocument**](JsonApiPublisherDocumentTemplateInDocument.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 -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.md) ### Authorization @@ -26895,12 +29274,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_data_sources** -> JsonApiDataSourceOutDocument update_entity_data_sources(id, json_api_data_source_in_document) - -Put Data Source entity +# **update_entity_documents** +> JsonApiPublisherDocumentOutDocument update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) -Data Source - represents data source for the workspace +Put a Document ### Example @@ -26909,8 +29286,8 @@ Data Source - represents data source for the workspace import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_in_document import JsonApiDataSourceInDocument -from gooddata_api_client.model.json_api_data_source_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument 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. @@ -26923,56 +29300,190 @@ 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 | - json_api_data_source_in_document = JsonApiDataSourceInDocument( - 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", - date_time_semantics="LOCAL", - disable_statistics=True, - name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_in_document = JsonApiPublisherDocumentInDocument( + data=JsonApiPublisherDocumentIn( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", ], - password="password_example", - private_key="private_key_example", - private_key_passphrase="private_key_passphrase_example", - schema="schema_example", - token="token_example", - type="POSTGRESQL", - url="url_example", - username="username_example", + title="title_example", + version="2", ), id="id1", - type="dataSource", + type="document", ), - ) # JsonApiDataSourceInDocument | - filter = "name==someString;type==DatabaseTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiPublisherDocumentInDocument | + filter = "version==someString;title==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 Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document) + # Put a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_documents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put Data Source entity - api_response = api_instance.update_entity_data_sources(id, json_api_data_source_in_document, filter=filter) + # Put a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->update_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->update_entity_documents: %s\n" % e) ``` @@ -26980,13 +29491,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_data_source_in_document** | [**JsonApiDataSourceInDocument**](JsonApiDataSourceInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_in_document** | [**JsonApiPublisherDocumentInDocument**](JsonApiPublisherDocumentInDocument.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 -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.md) ### Authorization @@ -28592,6 +31105,145 @@ 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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + +Put a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +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_publisher_document_page_template_in_document = JsonApiPublisherDocumentPageTemplateInDocument( + data=JsonApiPublisherDocumentPageTemplateIn( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplateInDocument | + filter = "version==someString;title==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 a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_in_document** | [**JsonApiPublisherDocumentPageTemplateInDocument**](JsonApiPublisherDocumentPageTemplateInDocument.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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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/GdStorageFile.md b/gooddata-api-client/docs/GdStorageFile.md index d2bf06c36..ecd656890 100644 --- a/gooddata-api-client/docs/GdStorageFile.md +++ b/gooddata-api-client/docs/GdStorageFile.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **modified_at** | **datetime** | Last modification timestamp of the file. | **name** | **str** | Name of the file. | **size** | **int** | Size of the file in bytes. | -**type** | **str** | Type of the file. | defaults to "CSV" +**type** | **str** | Type of the file. | **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/GenerateLogicalDataModelApi.md b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md index 2c2d5e88d..6c9ad6986 100644 --- a/gooddata-api-client/docs/GenerateLogicalDataModelApi.md +++ b/gooddata-api-client/docs/GenerateLogicalDataModelApi.md @@ -80,6 +80,7 @@ with gooddata_api_client.ApiClient() as api_client: columns=[ DeclarativeColumn( data_type="INT", + default_label_of="gender", description="Customer unique identifier", is_nullable=True, is_primary_key=True, @@ -92,6 +93,9 @@ with gooddata_api_client.ApiClient() as api_client: id="customers", name_prefix="out_gooddata", path=["table_schema","table_name"], + properties={ + "key": "key_example", + }, type="TABLE", ), ], diff --git a/gooddata-api-client/docs/GetImageExport202ResponseInner.md b/gooddata-api-client/docs/GetDocumentExport202ResponseInner.md similarity index 95% rename from gooddata-api-client/docs/GetImageExport202ResponseInner.md rename to gooddata-api-client/docs/GetDocumentExport202ResponseInner.md index 8a1164698..8b0cc3025 100644 --- a/gooddata-api-client/docs/GetImageExport202ResponseInner.md +++ b/gooddata-api-client/docs/GetDocumentExport202ResponseInner.md @@ -1,4 +1,4 @@ -# GetImageExport202ResponseInner +# GetDocumentExport202ResponseInner ## Properties diff --git a/gooddata-api-client/docs/ImageExportApi.md b/gooddata-api-client/docs/ImageExportApi.md index 5a63d82b0..24b57d0c9 100644 --- a/gooddata-api-client/docs/ImageExportApi.md +++ b/gooddata-api-client/docs/ImageExportApi.md @@ -113,7 +113,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import image_export_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. diff --git a/gooddata-api-client/docs/ImportSavRequest.md b/gooddata-api-client/docs/ImportSavRequest.md new file mode 100644 index 000000000..74836d4aa --- /dev/null +++ b/gooddata-api-client/docs/ImportSavRequest.md @@ -0,0 +1,13 @@ +# ImportSavRequest + +Request containing the information necessary to import one or more SPSS (.sav) files from the staging area. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tables** | [**[ImportSavRequestTable]**](ImportSavRequestTable.md) | Information about the individual tables. | +**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/ImportSavRequestTable.md b/gooddata-api-client/docs/ImportSavRequestTable.md new file mode 100644 index 000000000..db27e9ee7 --- /dev/null +++ b/gooddata-api-client/docs/ImportSavRequestTable.md @@ -0,0 +1,14 @@ +# ImportSavRequestTable + +Information about a particular table imported from an SPSS file. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the table. | +**source** | [**ImportSavRequestTableSource**](ImportSavRequestTableSource.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/ImportSavRequestTableSource.md b/gooddata-api-client/docs/ImportSavRequestTableSource.md new file mode 100644 index 000000000..d7193e04d --- /dev/null +++ b/gooddata-api-client/docs/ImportSavRequestTableSource.md @@ -0,0 +1,13 @@ +# ImportSavRequestTableSource + +Information about the SPSS source data of a particular table. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | **str** | Location of the data in the staging area. | +**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/ImportSavResponse.md b/gooddata-api-client/docs/ImportSavResponse.md new file mode 100644 index 000000000..c544511f4 --- /dev/null +++ b/gooddata-api-client/docs/ImportSavResponse.md @@ -0,0 +1,14 @@ +# ImportSavResponse + +Response containing the information about the imported SPSS (.sav) file. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the table the file was imported to. | +**version** | **int** | Version the file was imported as. | +**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/JsonApiDataSourceInAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md index 5e346d392..94d9ae3c8 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **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] **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] **disable_statistics** | **bool, none_type** | Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset. | [optional] +**ignore_jwt_aud** | **bool, none_type** | Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it. | [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] **password** | **str, none_type** | The password to use to connect to the database providing the data for the data source. | [optional] **private_key** | **str, none_type** | The private key to use to connect to the database providing the data for the data source. | [optional] diff --git a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md index 3f5598edd..d7b303a5e 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **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] **disable_statistics** | **bool, none_type** | Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset. | [optional] +**ignore_jwt_aud** | **bool, none_type** | Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it. | [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] diff --git a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md index 238fa4e1d..838e06886 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **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] **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] **disable_statistics** | **bool, none_type** | Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset. | [optional] +**ignore_jwt_aud** | **bool, none_type** | Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it. | [optional] **name** | **str** | User-facing name of the data source. | [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] **password** | **str, none_type** | The password to use to connect to the database providing the data for the data source. | [optional] diff --git a/gooddata-api-client/docs/JsonApiPublisherDocumentIn.md b/gooddata-api-client/docs/JsonApiPublisherDocumentIn.md new file mode 100644 index 000000000..25e52a0f4 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentIn.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentIn + +JSON:API representation of document entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentInAttributes**](JsonApiPublisherDocumentInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "document" +**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/JsonApiPublisherDocumentInAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributes.md new file mode 100644 index 000000000..c4801f6ab --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributes.md @@ -0,0 +1,18 @@ +# JsonApiPublisherDocumentInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentInAttributesContent**](JsonApiPublisherDocumentInAttributesContent.md) | | +**period** | [**JsonApiPublisherDocumentInAttributesPeriod**](JsonApiPublisherDocumentInAttributesPeriod.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentInAttributesContent.md b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributesContent.md new file mode 100644 index 000000000..4ac3f1803 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributesContent.md @@ -0,0 +1,20 @@ +# JsonApiPublisherDocumentInAttributesContent + +Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_filter_configs** | [**[PublisherDocumentAttributeFilterConfig]**](PublisherDocumentAttributeFilterConfig.md) | | [optional] +**defaults** | [**PublisherDocumentDefaults**](PublisherDocumentDefaults.md) | | [optional] +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Document filters, at most one per attribute display form or date dataset. | [optional] +**format_locale** | **str** | Locale for formatting dates in variables, charts and tables. | [optional] +**locale** | **str** | Locale of the text the product writes, such as `de-DE`. | [optional] +**pages** | [**[PublisherDocumentPage]**](PublisherDocumentPage.md) | The document's pages, when it has no sections. | [optional] +**sections** | [**[PublisherDocumentSection]**](PublisherDocumentSection.md) | Groups of pages, when the document has no top-level pages. | [optional] +**style** | [**PublisherDocumentAreaStyle**](PublisherDocumentAreaStyle.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/JsonApiPublisherDocumentInAttributesPeriod.md b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributesPeriod.md new file mode 100644 index 000000000..0652b9364 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentInAttributesPeriod.md @@ -0,0 +1,16 @@ +# JsonApiPublisherDocumentInAttributesPeriod + +The period the document covers, absolute or relative to today. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of the period. | defaults to "relative" +**_from** | **int** | Start of the period, in units relative to the current one. | [optional] +**granularity** | **str** | Date granularity of the period. | [optional] +**to** | **int** | End of the period, in units relative to the current one. | [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/JsonApiPublisherDocumentInDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentInDocument.md new file mode 100644 index 000000000..36d3961fe --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentInDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentIn**](JsonApiPublisherDocumentIn.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/JsonApiPublisherDocumentOut.md b/gooddata-api-client/docs/JsonApiPublisherDocumentOut.md new file mode 100644 index 000000000..eaa90689d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentOut.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentOut + +JSON:API representation of document entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentOutAttributes**](JsonApiPublisherDocumentOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "document" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentOutAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentOutAttributes.md new file mode 100644 index 000000000..93bd508d0 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentOutAttributes.md @@ -0,0 +1,20 @@ +# JsonApiPublisherDocumentOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentInAttributesContent**](JsonApiPublisherDocumentInAttributesContent.md) | | +**period** | [**JsonApiPublisherDocumentInAttributesPeriod**](JsonApiPublisherDocumentInAttributesPeriod.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] +**description** | **str** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentOutDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentOutDocument.md new file mode 100644 index 000000000..ae955c915 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentOutDocument.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentOut**](JsonApiPublisherDocumentOut.md) | | +**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutDocumentMeta**](JsonApiAgentOutDocumentMeta.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/JsonApiPublisherDocumentOutList.md b/gooddata-api-client/docs/JsonApiPublisherDocumentOutList.md new file mode 100644 index 000000000..70d83e56d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentOutList.md @@ -0,0 +1,16 @@ +# JsonApiPublisherDocumentOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiPublisherDocumentOutWithLinks]**](JsonApiPublisherDocumentOutWithLinks.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/JsonApiPublisherDocumentOutWithLinks.md b/gooddata-api-client/docs/JsonApiPublisherDocumentOutWithLinks.md new file mode 100644 index 000000000..c26d5af34 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentOutAttributes**](JsonApiPublisherDocumentOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "document" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentPageTemplateIn.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateIn.md new file mode 100644 index 000000000..58afc1901 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateIn.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPageTemplateIn + +JSON:API representation of pageTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPageTemplateInAttributes**](JsonApiPublisherDocumentPageTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "pageTemplate" +**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/JsonApiPublisherDocumentPageTemplateInAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInAttributes.md new file mode 100644 index 000000000..e454edcd1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInAttributes.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentPageTemplateInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentPageTemplateInAttributesContent**](JsonApiPublisherDocumentPageTemplateInAttributesContent.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentPageTemplateInAttributesContent.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInAttributesContent.md new file mode 100644 index 000000000..0a6dd7bea --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInAttributesContent.md @@ -0,0 +1,18 @@ +# JsonApiPublisherDocumentPageTemplateInAttributesContent + +One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**layout** | [**PublisherDocumentLayoutNode**](PublisherDocumentLayoutNode.md) | | +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Page filters; stored, not applied. | [optional] +**kind** | **str** | Editor hint. | [optional] +**notes** | **str** | Speaker notes in markdown, never drawn. | [optional] +**page_size** | **str** | | [optional] if omitted the server will use the default value of "widescreen" +**style** | [**PublisherDocumentPageStyle**](PublisherDocumentPageStyle.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/JsonApiPublisherDocumentPageTemplateInDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInDocument.md new file mode 100644 index 000000000..659e366e6 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateInDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentPageTemplateInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPageTemplateIn**](JsonApiPublisherDocumentPageTemplateIn.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/JsonApiPublisherDocumentPageTemplateOut.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOut.md new file mode 100644 index 000000000..1cabf0209 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOut.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentPageTemplateOut + +JSON:API representation of pageTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPageTemplateOutAttributes**](JsonApiPublisherDocumentPageTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "pageTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentPageTemplateOutAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutAttributes.md new file mode 100644 index 000000000..814f94979 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutAttributes.md @@ -0,0 +1,19 @@ +# JsonApiPublisherDocumentPageTemplateOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentPageTemplateInAttributesContent**](JsonApiPublisherDocumentPageTemplateInAttributesContent.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] +**description** | **str** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentPageTemplateOutDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutDocument.md new file mode 100644 index 000000000..b088df515 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutDocument.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPageTemplateOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPageTemplateOut**](JsonApiPublisherDocumentPageTemplateOut.md) | | +**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutDocumentMeta**](JsonApiAgentOutDocumentMeta.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/JsonApiPublisherDocumentPageTemplateOutList.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutList.md new file mode 100644 index 000000000..cd517aa71 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutList.md @@ -0,0 +1,16 @@ +# JsonApiPublisherDocumentPageTemplateOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiPublisherDocumentPageTemplateOutWithLinks]**](JsonApiPublisherDocumentPageTemplateOutWithLinks.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/JsonApiPublisherDocumentPageTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutWithLinks.md new file mode 100644 index 000000000..af549a501 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplateOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentPageTemplateOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPageTemplateOutAttributes**](JsonApiPublisherDocumentPageTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "pageTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentPageTemplatePatch.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatch.md new file mode 100644 index 000000000..41ca4745d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatch.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPageTemplatePatch + +JSON:API representation of patching pageTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPageTemplatePatchAttributes**](JsonApiPublisherDocumentPageTemplatePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "pageTemplate" +**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/JsonApiPublisherDocumentPageTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatchAttributes.md new file mode 100644 index 000000000..efebfc4b2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatchAttributes.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentPageTemplatePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiPublisherDocumentPageTemplateInAttributesContent**](JsonApiPublisherDocumentPageTemplateInAttributesContent.md) | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**version** | **str** | Version of the content format. | [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/JsonApiPublisherDocumentPageTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatchDocument.md new file mode 100644 index 000000000..8a257390b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentPageTemplatePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPageTemplatePatch**](JsonApiPublisherDocumentPageTemplatePatch.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/JsonApiPublisherDocumentPageTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePostOptionalId.md new file mode 100644 index 000000000..0de989be4 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPageTemplatePostOptionalId + +JSON:API representation of pageTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPageTemplateInAttributes**](JsonApiPublisherDocumentPageTemplateInAttributes.md) | | +**type** | **str** | Object type | defaults to "pageTemplate" +**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/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..8faef30bf --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPageTemplatePostOptionalId**](JsonApiPublisherDocumentPageTemplatePostOptionalId.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/JsonApiPublisherDocumentPatch.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPatch.md new file mode 100644 index 000000000..25867d777 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPatch.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPatch + +JSON:API representation of patching document entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentPatchAttributes**](JsonApiPublisherDocumentPatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "document" +**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/JsonApiPublisherDocumentPatchAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPatchAttributes.md new file mode 100644 index 000000000..7360d1dd5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPatchAttributes.md @@ -0,0 +1,18 @@ +# JsonApiPublisherDocumentPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiPublisherDocumentInAttributesContent**](JsonApiPublisherDocumentInAttributesContent.md) | | [optional] +**description** | **str** | | [optional] +**period** | [**JsonApiPublisherDocumentInAttributesPeriod**](JsonApiPublisherDocumentInAttributesPeriod.md) | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**version** | **str** | Version of the content format. | [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/JsonApiPublisherDocumentPatchDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPatchDocument.md new file mode 100644 index 000000000..1504b9d95 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentPatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPatch**](JsonApiPublisherDocumentPatch.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/JsonApiPublisherDocumentPostOptionalId.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPostOptionalId.md new file mode 100644 index 000000000..b13b66e18 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentPostOptionalId + +JSON:API representation of document entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentInAttributes**](JsonApiPublisherDocumentInAttributes.md) | | +**type** | **str** | Object type | defaults to "document" +**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/JsonApiPublisherDocumentPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentPostOptionalIdDocument.md new file mode 100644 index 000000000..4fc7a6407 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentPostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentPostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentPostOptionalId**](JsonApiPublisherDocumentPostOptionalId.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/JsonApiPublisherDocumentTemplateIn.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateIn.md new file mode 100644 index 000000000..3c205be02 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateIn.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentTemplateIn + +JSON:API representation of documentTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentTemplateInAttributes**](JsonApiPublisherDocumentTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "documentTemplate" +**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/JsonApiPublisherDocumentTemplateInAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInAttributes.md new file mode 100644 index 000000000..a4b70b989 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInAttributes.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentTemplateInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentTemplateInAttributesContent**](JsonApiPublisherDocumentTemplateInAttributesContent.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentTemplateInAttributesContent.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInAttributesContent.md new file mode 100644 index 000000000..40af53865 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInAttributesContent.md @@ -0,0 +1,20 @@ +# JsonApiPublisherDocumentTemplateInAttributesContent + +Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_filter_configs** | [**[PublisherDocumentAttributeFilterConfig]**](PublisherDocumentAttributeFilterConfig.md) | | [optional] +**defaults** | [**PublisherDocumentDefaults**](PublisherDocumentDefaults.md) | | [optional] +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Document filters, at most one per attribute display form or date dataset. | [optional] +**format_locale** | **str** | Locale for formatting dates in variables, charts and tables. | [optional] +**locale** | **str** | Locale of the text the product writes, such as `de-DE`. | [optional] +**pages** | [**[PublisherDocumentPage]**](PublisherDocumentPage.md) | The document's pages, when it has no sections. | [optional] +**sections** | [**[PublisherDocumentSection]**](PublisherDocumentSection.md) | Groups of pages, when the document has no top-level pages. | [optional] +**style** | [**PublisherDocumentAreaStyle**](PublisherDocumentAreaStyle.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/JsonApiPublisherDocumentTemplateInDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInDocument.md new file mode 100644 index 000000000..039c275bc --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateInDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentTemplateInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentTemplateIn**](JsonApiPublisherDocumentTemplateIn.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/JsonApiPublisherDocumentTemplateOut.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOut.md new file mode 100644 index 000000000..91d470f8a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOut.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentTemplateOut + +JSON:API representation of documentTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentTemplateOutAttributes**](JsonApiPublisherDocumentTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "documentTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentTemplateOutAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutAttributes.md new file mode 100644 index 000000000..db475853e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutAttributes.md @@ -0,0 +1,19 @@ +# JsonApiPublisherDocumentTemplateOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiPublisherDocumentTemplateInAttributesContent**](JsonApiPublisherDocumentTemplateInAttributesContent.md) | | +**title** | **str** | | +**version** | **str** | Version of the content format. | +**are_relations_valid** | **bool** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] +**description** | **str** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] +**tags** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[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/JsonApiPublisherDocumentTemplateOutDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutDocument.md new file mode 100644 index 000000000..31fbd6efd --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutDocument.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentTemplateOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentTemplateOut**](JsonApiPublisherDocumentTemplateOut.md) | | +**included** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | Included resources | [optional] +**links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] +**meta** | [**JsonApiAgentOutDocumentMeta**](JsonApiAgentOutDocumentMeta.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/JsonApiPublisherDocumentTemplateOutList.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutList.md new file mode 100644 index 000000000..353a19e9e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutList.md @@ -0,0 +1,16 @@ +# JsonApiPublisherDocumentTemplateOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiPublisherDocumentTemplateOutWithLinks]**](JsonApiPublisherDocumentTemplateOutWithLinks.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/JsonApiPublisherDocumentTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutWithLinks.md new file mode 100644 index 000000000..35662e3aa --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplateOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentTemplateOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentTemplateOutAttributes**](JsonApiPublisherDocumentTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "documentTemplate" +**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**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/JsonApiPublisherDocumentTemplatePatch.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatch.md new file mode 100644 index 000000000..3b76cb825 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatch.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentTemplatePatch + +JSON:API representation of patching documentTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentTemplatePatchAttributes**](JsonApiPublisherDocumentTemplatePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "documentTemplate" +**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/JsonApiPublisherDocumentTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatchAttributes.md new file mode 100644 index 000000000..1cc984e92 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatchAttributes.md @@ -0,0 +1,17 @@ +# JsonApiPublisherDocumentTemplatePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiPublisherDocumentTemplateInAttributesContent**](JsonApiPublisherDocumentTemplateInAttributesContent.md) | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**version** | **str** | Version of the content format. | [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/JsonApiPublisherDocumentTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatchDocument.md new file mode 100644 index 000000000..04da70bb5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentTemplatePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentTemplatePatch**](JsonApiPublisherDocumentTemplatePatch.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/JsonApiPublisherDocumentTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePostOptionalId.md new file mode 100644 index 000000000..e938c8afa --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiPublisherDocumentTemplatePostOptionalId + +JSON:API representation of documentTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiPublisherDocumentTemplateInAttributes**](JsonApiPublisherDocumentTemplateInAttributes.md) | | +**type** | **str** | Object type | defaults to "documentTemplate" +**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/JsonApiPublisherDocumentTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..7c5e763ea --- /dev/null +++ b/gooddata-api-client/docs/JsonApiPublisherDocumentTemplatePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiPublisherDocumentTemplatePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiPublisherDocumentTemplatePostOptionalId**](JsonApiPublisherDocumentTemplatePostOptionalId.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/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index f671730a8..335ccd84c 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -1898,6 +1898,7 @@ with gooddata_api_client.ApiClient() as api_client: ], disable_statistics=True, id="pg_local_docker-demo", + ignore_jwt_aud=True, name="postgres demo", parameters=[ Parameter( @@ -2412,6 +2413,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -2503,10 +2817,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -2608,6 +2976,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), @@ -3136,6 +3507,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -3227,10 +3911,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -3332,6 +4070,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), @@ -4737,6 +5478,7 @@ with gooddata_api_client.ApiClient() as api_client: ], disable_statistics=True, id="pg_local_docker-demo", + ignore_jwt_aud=True, name="postgres demo", parameters=[ Parameter( @@ -5623,6 +6365,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -5714,10 +6769,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -5819,6 +6928,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), @@ -7290,6 +8402,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -7381,10 +8806,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -7486,6 +8965,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), diff --git a/gooddata-api-client/docs/LocalizationApi.md b/gooddata-api-client/docs/LocalizationApi.md new file mode 100644 index 000000000..fbfd06a4d --- /dev/null +++ b/gooddata-api-client/docs/LocalizationApi.md @@ -0,0 +1,519 @@ +# gooddata_api_client.LocalizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**organization_localization_statistics**](LocalizationApi.md#organization_localization_statistics) | **GET** /api/v1/actions/organization/localization/statistics | (BETA) Languages with translations in the organization. +[**organization_localization_usage**](LocalizationApi.md#organization_localization_usage) | **GET** /api/v1/actions/organization/localization/usage | (BETA) Languages used in the organization. +[**organization_localization_usage_users**](LocalizationApi.md#organization_localization_usage_users) | **GET** /api/v1/actions/organization/localization/usage/users | (BETA) Users who set a language themselves. +[**organization_localization_usage_workspaces**](LocalizationApi.md#organization_localization_usage_workspaces) | **GET** /api/v1/actions/organization/localization/usage/workspaces | (BETA) Workspaces that use a language. +[**workspace_localization_statistics**](LocalizationApi.md#workspace_localization_statistics) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/statistics | (BETA) Languages with translations in the workspace. +[**workspace_localization_usage**](LocalizationApi.md#workspace_localization_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage | (BETA) Languages used in the workspace. +[**workspace_localization_usage_users**](LocalizationApi.md#workspace_localization_usage_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/localization/usage/users | (BETA) Workspace members who get a language. + + +# **organization_localization_statistics** +> LocalizationStatistics organization_localization_statistics() + +(BETA) Languages with translations in the organization. + +(BETA) Lists the languages that have at least one translation, separately for each kind of translation. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_statistics import LocalizationStatistics +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Languages with translations in the organization. + api_response = api_instance.organization_localization_statistics() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_statistics: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LocalizationStatistics**](LocalizationStatistics.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **organization_localization_usage** +> LocalizationUsage organization_localization_usage() + +(BETA) Languages used in the organization. + +(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_usage import LocalizationUsage +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # (BETA) Languages used in the organization. + api_response = api_instance.organization_localization_usage() + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_usage: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LocalizationUsage**](LocalizationUsage.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **organization_localization_usage_users** +> LocalizationUsageUsers organization_localization_usage_users() + +(BETA) Users who set a language themselves. + +(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + value = "de-DE" # str | Language tag that the user sets. (optional) + name = "ito" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "USER" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Users who set a language themselves. + api_response = api_instance.organization_localization_usage_users(value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_usage_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **value** | **str**| Language tag that the user sets. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageUsers**](LocalizationUsageUsers.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **organization_localization_usage_workspaces** +> LocalizationUsageWorkspaces organization_localization_usage_workspaces() + +(BETA) Workspaces that use a language. + +(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + value = "de-DE" # str | Language tag that the workspace gets. (optional) + name = "berg" # str | Filter by workspace name. Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "PARENT" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspaces that use a language. + api_response = api_instance.organization_localization_usage_workspaces(value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->organization_localization_usage_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **value** | **str**| Language tag that the workspace gets. | [optional] + **name** | **str**| Filter by workspace name. Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageWorkspaces**](LocalizationUsageWorkspaces.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workspace_localization_statistics** +> LocalizationStatistics workspace_localization_statistics(workspace_id) + +(BETA) Languages with translations in the workspace. + +(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_statistics import LocalizationStatistics +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Languages with translations in the workspace. + api_response = api_instance.workspace_localization_statistics(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**LocalizationStatistics**](LocalizationStatistics.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) + +# **workspace_localization_usage** +> WorkspaceLocalizationUsage workspace_localization_usage(workspace_id) + +(BETA) Languages used in the workspace. + +(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.workspace_localization_usage import WorkspaceLocalizationUsage +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + workspace_id = "workspaceId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Languages used in the workspace. + api_response = api_instance.workspace_localization_usage(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_usage: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + +### Return type + +[**WorkspaceLocalizationUsage**](WorkspaceLocalizationUsage.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) + +# **workspace_localization_usage_users** +> LocalizationUsageUsers workspace_localization_usage_users(workspace_id) + +(BETA) Workspace members who get a language. + +(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import localization_api +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = localization_api.LocalizationApi(api_client) + workspace_id = "workspaceId_example" # str | + value = "de-DE" # str | Language tag that the user gets. (optional) + name = "ito" # str | Filter by user name, email or login (user ID). Note that the filter is case insensitive. (optional) + setting = "LOCALE" # str | One of LOCALE, METADATA_LOCALE and DATA_LOCALE. (optional) + source = "WORKSPACE" # str | Where the value comes from. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned. (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + try: + # (BETA) Workspace members who get a language. + api_response = api_instance.workspace_localization_usage_users(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_usage_users: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Workspace members who get a language. + api_response = api_instance.workspace_localization_usage_users(workspace_id, value=value, name=name, setting=setting, source=source, page=page, size=size) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling LocalizationApi->workspace_localization_usage_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **value** | **str**| Language tag that the user gets. | [optional] + **name** | **str**| Filter by user name, email or login (user ID). Note that the filter is case insensitive. | [optional] + **setting** | **str**| One of LOCALE, METADATA_LOCALE and DATA_LOCALE. | [optional] + **source** | **str**| Where the value comes from. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned. | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**LocalizationUsageUsers**](LocalizationUsageUsers.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) + diff --git a/gooddata-api-client/docs/LocalizationContent.md b/gooddata-api-client/docs/LocalizationContent.md new file mode 100644 index 000000000..6a5550e0d --- /dev/null +++ b/gooddata-api-client/docs/LocalizationContent.md @@ -0,0 +1,12 @@ +# LocalizationContent + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str, none_type** | Language tag, or null when no language is 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/LocalizationCount.md b/gooddata-api-client/docs/LocalizationCount.md new file mode 100644 index 000000000..94d7b16ab --- /dev/null +++ b/gooddata-api-client/docs/LocalizationCount.md @@ -0,0 +1,13 @@ +# LocalizationCount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by_source** | [**LocalizationSourceCounts**](LocalizationSourceCounts.md) | | +**total** | **int** | | +**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/LocalizationDataStatistics.md b/gooddata-api-client/docs/LocalizationDataStatistics.md new file mode 100644 index 000000000..071453abf --- /dev/null +++ b/gooddata-api-client/docs/LocalizationDataStatistics.md @@ -0,0 +1,13 @@ +# LocalizationDataStatistics + +Translations of labels in the logical data model. `locales` lists the languages with at least one label translation, sorted. Language tags do not include extensions. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locales** | [**[LocalizationStatisticsLocale]**](LocalizationStatisticsLocale.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/LocalizationDefault.md b/gooddata-api-client/docs/LocalizationDefault.md new file mode 100644 index 000000000..608653d63 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationDefault.md @@ -0,0 +1,14 @@ +# LocalizationDefault + +The value a workspace gets for one setting when it and its parents set nothing, and where it comes from. Null when that value has no language. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**LocalizationContent**](LocalizationContent.md) | | +**source** | **str** | Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. | +**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/LocalizationDefaults.md b/gooddata-api-client/docs/LocalizationDefaults.md new file mode 100644 index 000000000..0cda20ff7 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationDefaults.md @@ -0,0 +1,14 @@ +# LocalizationDefaults + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_locale** | [**LocalizationDefault**](LocalizationDefault.md) | | [optional] +**locale** | [**LocalizationDefault**](LocalizationDefault.md) | | [optional] +**metadata_locale** | [**LocalizationDefault**](LocalizationDefault.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/LocalizationMetadataStatistics.md b/gooddata-api-client/docs/LocalizationMetadataStatistics.md new file mode 100644 index 000000000..aa8e0e3dd --- /dev/null +++ b/gooddata-api-client/docs/LocalizationMetadataStatistics.md @@ -0,0 +1,13 @@ +# LocalizationMetadataStatistics + +Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locales** | [**[LocalizationStatisticsLocale]**](LocalizationStatisticsLocale.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/LocalizationResolvedValue.md b/gooddata-api-client/docs/LocalizationResolvedValue.md new file mode 100644 index 000000000..7c67dd32b --- /dev/null +++ b/gooddata-api-client/docs/LocalizationResolvedValue.md @@ -0,0 +1,15 @@ +# LocalizationResolvedValue + +The value a workspace gets for one setting, and where it comes from. Never null. `content.value` is null when the workspace gets no language. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**LocalizationContent**](LocalizationContent.md) | | +**source** | **str** | Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. | +**origin_id** | **str, none_type** | The ancestor workspace that sets the value. Null unless the source is PARENT. | [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/LocalizationResolvedValues.md b/gooddata-api-client/docs/LocalizationResolvedValues.md new file mode 100644 index 000000000..ccee20f50 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationResolvedValues.md @@ -0,0 +1,15 @@ +# LocalizationResolvedValues + +The value for each of the display, metadata and data language settings, with its source. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_locale** | [**LocalizationResolvedValue**](LocalizationResolvedValue.md) | | +**locale** | [**LocalizationResolvedValue**](LocalizationResolvedValue.md) | | +**metadata_locale** | [**LocalizationResolvedValue**](LocalizationResolvedValue.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/LocalizationSettingUsage.md b/gooddata-api-client/docs/LocalizationSettingUsage.md new file mode 100644 index 000000000..8238a1df5 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationSettingUsage.md @@ -0,0 +1,13 @@ +# LocalizationSettingUsage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**users** | [**LocalizationCount**](LocalizationCount.md) | | +**workspaces** | [**LocalizationCount**](LocalizationCount.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/LocalizationSettingUsages.md b/gooddata-api-client/docs/LocalizationSettingUsages.md new file mode 100644 index 000000000..216bf0240 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationSettingUsages.md @@ -0,0 +1,15 @@ +# LocalizationSettingUsages + +The same counts per setting. Settings without this language are left out. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_locale** | [**LocalizationSettingUsage**](LocalizationSettingUsage.md) | | [optional] +**locale** | [**LocalizationSettingUsage**](LocalizationSettingUsage.md) | | [optional] +**metadata_locale** | [**LocalizationSettingUsage**](LocalizationSettingUsage.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/LocalizationSourceCounts.md b/gooddata-api-client/docs/LocalizationSourceCounts.md new file mode 100644 index 000000000..81213144f --- /dev/null +++ b/gooddata-api-client/docs/LocalizationSourceCounts.md @@ -0,0 +1,18 @@ +# LocalizationSourceCounts + +Counts per source. Sources without any count are left out. In the organization, users without their own setting have no source and are only in the total. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**default** | **int** | | [optional] +**environment** | **int** | | [optional] +**organization** | **int** | | [optional] +**parent** | **int** | | [optional] +**user** | **int** | | [optional] +**workspace** | **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/LocalizationStatistics.md b/gooddata-api-client/docs/LocalizationStatistics.md new file mode 100644 index 000000000..bd1066532 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationStatistics.md @@ -0,0 +1,13 @@ +# LocalizationStatistics + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**LocalizationDataStatistics**](LocalizationDataStatistics.md) | | +**metadata** | [**LocalizationMetadataStatistics**](LocalizationMetadataStatistics.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/LocalizationStatisticsLocale.md b/gooddata-api-client/docs/LocalizationStatisticsLocale.md new file mode 100644 index 000000000..6aa8a109d --- /dev/null +++ b/gooddata-api-client/docs/LocalizationStatisticsLocale.md @@ -0,0 +1,12 @@ +# LocalizationStatisticsLocale + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | Language tag. | +**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/LocalizationUsage.md b/gooddata-api-client/docs/LocalizationUsage.md new file mode 100644 index 000000000..b4664fc98 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsage.md @@ -0,0 +1,13 @@ +# LocalizationUsage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaults** | [**LocalizationDefaults**](LocalizationDefaults.md) | | +**values** | [**[LocalizationUsageValue]**](LocalizationUsageValue.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/LocalizationUsageUser.md b/gooddata-api-client/docs/LocalizationUsageUser.md new file mode 100644 index 000000000..f5e3f0d45 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsageUser.md @@ -0,0 +1,16 @@ +# LocalizationUsageUser + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by_setting** | [**LocalizationUserValues**](LocalizationUserValues.md) | | +**id** | **str** | | +**source** | **str** | Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. | +**email** | **str, none_type** | | [optional] +**name** | **str, none_type** | First and last name. Null when the user has neither. | [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/LocalizationUsageUsers.md b/gooddata-api-client/docs/LocalizationUsageUsers.md new file mode 100644 index 000000000..051739b1f --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsageUsers.md @@ -0,0 +1,13 @@ +# LocalizationUsageUsers + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_count** | **int** | The total number of users that match the filters. | +**users** | [**[LocalizationUsageUser]**](LocalizationUsageUser.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/LocalizationUsageValue.md b/gooddata-api-client/docs/LocalizationUsageValue.md new file mode 100644 index 000000000..6d7a8c3c6 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsageValue.md @@ -0,0 +1,16 @@ +# LocalizationUsageValue + +One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by_setting** | [**LocalizationSettingUsages**](LocalizationSettingUsages.md) | | +**content** | [**LocalizationContent**](LocalizationContent.md) | | +**users** | [**LocalizationCount**](LocalizationCount.md) | | +**workspaces** | [**LocalizationCount**](LocalizationCount.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/LocalizationUsageWorkspace.md b/gooddata-api-client/docs/LocalizationUsageWorkspace.md new file mode 100644 index 000000000..b11298164 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsageWorkspace.md @@ -0,0 +1,17 @@ +# LocalizationUsageWorkspace + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by_setting** | [**LocalizationResolvedValues**](LocalizationResolvedValues.md) | | +**children_count** | **int** | Number of direct child workspaces. | +**id** | **str** | | +**name** | **str** | | +**source** | **str** | Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. | +**parent_id** | **str, none_type** | The parent workspace, or null for a root workspace. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/LocalizationUsageWorkspaces.md b/gooddata-api-client/docs/LocalizationUsageWorkspaces.md new file mode 100644 index 000000000..447424032 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUsageWorkspaces.md @@ -0,0 +1,13 @@ +# LocalizationUsageWorkspaces + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_count** | **int** | The total number of workspaces that match the filters. | +**workspaces** | [**[LocalizationUsageWorkspace]**](LocalizationUsageWorkspace.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/LocalizationUserValue.md b/gooddata-api-client/docs/LocalizationUserValue.md new file mode 100644 index 000000000..4ffd638d0 --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUserValue.md @@ -0,0 +1,14 @@ +# LocalizationUserValue + +The value a user gets for one setting, and where it comes from. In the organization users list, it is the value the user sets, with source USER. It is null when the user does not set the setting, because the value then depends on the workspace. In the workspace users list, it is never null. It is the value the user sets, with source USER. Otherwise it is the value the workspace gets, with the source of the workspace. For the origin of that value, see `originId` in the workspace usage. `content.value` is null when the user gets no language. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**LocalizationContent**](LocalizationContent.md) | | +**source** | **str** | Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. | +**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/LocalizationUserValues.md b/gooddata-api-client/docs/LocalizationUserValues.md new file mode 100644 index 000000000..4b30aeefd --- /dev/null +++ b/gooddata-api-client/docs/LocalizationUserValues.md @@ -0,0 +1,15 @@ +# LocalizationUserValues + +The value the user gets for each setting. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_locale** | [**LocalizationUserValue**](LocalizationUserValue.md) | | [optional] +**locale** | [**LocalizationUserValue**](LocalizationUserValue.md) | | [optional] +**metadata_locale** | [**LocalizationUserValue**](LocalizationUserValue.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/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index b8e766115..0f8c08996 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -479,6 +479,7 @@ with gooddata_api_client.ApiClient() as api_client: ], disable_statistics=True, id="pg_local_docker-demo", + ignore_jwt_aud=True, name="postgres demo", parameters=[ Parameter( @@ -1365,6 +1366,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -1456,10 +1770,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -1561,6 +1929,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), diff --git a/gooddata-api-client/docs/PageTemplateControllerApi.md b/gooddata-api-client/docs/PageTemplateControllerApi.md new file mode 100644 index 000000000..8d04729b5 --- /dev/null +++ b/gooddata-api-client/docs/PageTemplateControllerApi.md @@ -0,0 +1,680 @@ +# gooddata_api_client.PageTemplateControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_page_templates**](PageTemplateControllerApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template +[**delete_entity_page_templates**](PageTemplateControllerApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template +[**get_all_entities_page_templates**](PageTemplateControllerApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates +[**get_entity_page_templates**](PageTemplateControllerApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template +[**patch_entity_page_templates**](PageTemplateControllerApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +[**update_entity_page_templates**](PageTemplateControllerApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template + + +# **create_entity_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + +Post Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +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 = page_template_controller_api.PageTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_page_template_post_optional_id_document = JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentPageTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->create_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->create_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_page_template_post_optional_id_document** | [**JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_page_templates** +> delete_entity_page_templates(workspace_id, object_id) + +Delete a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_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 = page_template_controller_api.PageTemplateControllerApi(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 Page Template + api_instance.delete_entity_page_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->delete_entity_page_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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutList get_all_entities_page_templates(workspace_id) + +Get all Page Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +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 = page_template_controller_api.PageTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Page Templates + api_response = api_instance.get_all_entities_page_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->get_all_entities_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Page Templates + api_response = api_instance.get_all_entities_page_templates(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 PageTemplateControllerApi->get_all_entities_page_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] + **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 + +[**JsonApiPublisherDocumentPageTemplateOutList**](JsonApiPublisherDocumentPageTemplateOutList.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument get_entity_page_templates(workspace_id, object_id) + +Get a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +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 = page_template_controller_api.PageTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Page Template + api_response = api_instance.get_entity_page_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->get_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Page Template + api_response = api_instance.get_entity_page_templates(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 PageTemplateControllerApi->get_entity_page_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] + **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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) + +Patch a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +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 = page_template_controller_api.PageTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_page_template_patch_document = JsonApiPublisherDocumentPageTemplatePatchDocument( + data=JsonApiPublisherDocumentPageTemplatePatch( + attributes=JsonApiPublisherDocumentPageTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplatePatchDocument | + filter = "version==someString;title==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 a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->patch_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->patch_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_patch_document** | [**JsonApiPublisherDocumentPageTemplatePatchDocument**](JsonApiPublisherDocumentPageTemplatePatchDocument.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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + +Put a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import page_template_controller_api +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +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 = page_template_controller_api.PageTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_page_template_in_document = JsonApiPublisherDocumentPageTemplateInDocument( + data=JsonApiPublisherDocumentPageTemplateIn( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplateInDocument | + filter = "version==someString;title==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 a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->update_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PageTemplateControllerApi->update_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_in_document** | [**JsonApiPublisherDocumentPageTemplateInDocument**](JsonApiPublisherDocumentPageTemplateInDocument.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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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/PublisherDocumentArbitraryAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentArbitraryAttributeFilter.md new file mode 100644 index 000000000..3b14dadad --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentArbitraryAttributeFilter.md @@ -0,0 +1,13 @@ +# PublisherDocumentArbitraryAttributeFilter + +Filters an attribute display form by arbitrary values. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arbitrary_attribute_filter** | [**PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter**](PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.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/PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md new file mode 100644 index 000000000..eabbed0f5 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md @@ -0,0 +1,19 @@ +# PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_form** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**negative_selection** | **bool** | | +**values** | **[str]** | Values; `null` stands for an empty value. | +**filter_elements_by** | [**[PublisherDocumentAttributeFilterParent]**](PublisherDocumentAttributeFilterParent.md) | | [optional] +**filter_elements_by_date** | [**[PublisherDocumentAttributeFilterByDate]**](PublisherDocumentAttributeFilterByDate.md) | | [optional] +**local_identifier** | **str** | Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter. | [optional] +**title** | **str** | | [optional] +**validate_elements_by** | [**[PublisherDocumentObjRef]**](PublisherDocumentObjRef.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/PublisherDocumentAreaStyle.md b/gooddata-api-client/docs/PublisherDocumentAreaStyle.md new file mode 100644 index 000000000..e5b992b2c --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAreaStyle.md @@ -0,0 +1,25 @@ +# PublisherDocumentAreaStyle + +Style of the area behind the pages. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**gap** | [**PublisherDocumentAreaStyleGap**](PublisherDocumentAreaStyleGap.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/PublisherDocumentAreaStyleGap.md b/gooddata-api-client/docs/PublisherDocumentAreaStyleGap.md new file mode 100644 index 000000000..17d23b95e --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAreaStyleGap.md @@ -0,0 +1,12 @@ +# PublisherDocumentAreaStyleGap + +A length, or `{theme.spacing.gap.}`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/PublisherDocumentAttributeElements.md b/gooddata-api-client/docs/PublisherDocumentAttributeElements.md new file mode 100644 index 000000000..faa819ff0 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeElements.md @@ -0,0 +1,14 @@ +# PublisherDocumentAttributeElements + +Selected attribute elements: `{\"values\": [...]}` or `{\"uris\": [...]}`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | **[str]** | Element values; `null` stands for an empty value. | [optional] +**uris** | **[str]** | Element URIs; `null` stands for an empty value. | [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/PublisherDocumentAttributeElementsByUri.md b/gooddata-api-client/docs/PublisherDocumentAttributeElementsByUri.md new file mode 100644 index 000000000..09d5dce85 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeElementsByUri.md @@ -0,0 +1,12 @@ +# PublisherDocumentAttributeElementsByUri + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uris** | **[str]** | Element URIs; `null` stands for an empty value. | +**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/PublisherDocumentAttributeElementsByValue.md b/gooddata-api-client/docs/PublisherDocumentAttributeElementsByValue.md new file mode 100644 index 000000000..7cd855b1d --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeElementsByValue.md @@ -0,0 +1,12 @@ +# PublisherDocumentAttributeElementsByValue + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | **[str]** | Element values; `null` stands for an empty value. | +**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/PublisherDocumentAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilter.md new file mode 100644 index 000000000..79ebeb80a --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilter.md @@ -0,0 +1,13 @@ +# PublisherDocumentAttributeFilter + +Filters an attribute display form by a list of elements. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_filter** | [**PublisherDocumentAttributeFilterAttributeFilter**](PublisherDocumentAttributeFilterAttributeFilter.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/PublisherDocumentAttributeFilterAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterAttributeFilter.md new file mode 100644 index 000000000..427212999 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterAttributeFilter.md @@ -0,0 +1,20 @@ +# PublisherDocumentAttributeFilterAttributeFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_elements** | [**PublisherDocumentAttributeElements**](PublisherDocumentAttributeElements.md) | | +**display_form** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**negative_selection** | **bool** | | +**filter_elements_by** | [**[PublisherDocumentAttributeFilterParent]**](PublisherDocumentAttributeFilterParent.md) | Parent filters that limit the offered elements. | [optional] +**filter_elements_by_date** | [**[PublisherDocumentAttributeFilterByDate]**](PublisherDocumentAttributeFilterByDate.md) | Date filters that limit the offered elements. | [optional] +**local_identifier** | **str** | Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter. | [optional] +**selection_mode** | **str** | | [optional] +**title** | **str** | | [optional] +**validate_elements_by** | [**[PublisherDocumentObjRef]**](PublisherDocumentObjRef.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/PublisherDocumentAttributeFilterByDate.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterByDate.md new file mode 100644 index 000000000..72d89f69d --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterByDate.md @@ -0,0 +1,15 @@ +# PublisherDocumentAttributeFilterByDate + +A date filter that limits the offered elements. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter_local_identifier** | **str** | | +**is_common_date** | **bool** | | +**data_set** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.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/PublisherDocumentAttributeFilterConfig.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterConfig.md new file mode 100644 index 000000000..0cd64bc8c --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterConfig.md @@ -0,0 +1,16 @@ +# PublisherDocumentAttributeFilterConfig + +How a document attribute filter is shown, as in dashboards. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**local_identifier** | **str** | | +**display_as_label** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | [optional] +**mode** | **str** | | [optional] +**selection_type** | **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/PublisherDocumentAttributeFilterParent.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterParent.md new file mode 100644 index 000000000..50fa5b025 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterParent.md @@ -0,0 +1,14 @@ +# PublisherDocumentAttributeFilterParent + +A parent attribute filter that limits the offered elements. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter_local_identifier** | **str** | | +**over** | [**PublisherDocumentAttributeFilterParentOver**](PublisherDocumentAttributeFilterParentOver.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/PublisherDocumentAttributeFilterParentOver.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterParentOver.md new file mode 100644 index 000000000..a6d5589f9 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterParentOver.md @@ -0,0 +1,13 @@ +# PublisherDocumentAttributeFilterParentOver + +Attributes that connect the parent and the child filter in the data model. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[PublisherDocumentObjRef]**](PublisherDocumentObjRef.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/PublisherDocumentAttributeFilterReference.md b/gooddata-api-client/docs/PublisherDocumentAttributeFilterReference.md new file mode 100644 index 000000000..f2bcf5d53 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAttributeFilterReference.md @@ -0,0 +1,13 @@ +# PublisherDocumentAttributeFilterReference + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_form** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**type** | **str** | | defaults to "attributeFilterReference" +**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/PublisherDocumentAutoVisibility.md b/gooddata-api-client/docs/PublisherDocumentAutoVisibility.md new file mode 100644 index 000000000..e816ec1f8 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAutoVisibility.md @@ -0,0 +1,12 @@ +# PublisherDocumentAutoVisibility + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible** | [**PublisherDocumentAutoVisibilityVisible**](PublisherDocumentAutoVisibilityVisible.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/PublisherDocumentAutoVisibilityVisible.md b/gooddata-api-client/docs/PublisherDocumentAutoVisibilityVisible.md new file mode 100644 index 000000000..67419a8ed --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAutoVisibilityVisible.md @@ -0,0 +1,12 @@ +# PublisherDocumentAutoVisibilityVisible + +`true`, `false` or `\"auto\"`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/PublisherDocumentAxisDisplay.md b/gooddata-api-client/docs/PublisherDocumentAxisDisplay.md new file mode 100644 index 000000000..47c3c4459 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAxisDisplay.md @@ -0,0 +1,16 @@ +# PublisherDocumentAxisDisplay + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max** | **float** | | [optional] +**min** | **float** | | [optional] +**name** | [**PublisherDocumentAxisNameDisplay**](PublisherDocumentAxisNameDisplay.md) | | [optional] +**values** | [**PublisherDocumentAxisValuesDisplay**](PublisherDocumentAxisValuesDisplay.md) | | [optional] +**visible** | **bool** | | [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/PublisherDocumentAxisNameDisplay.md b/gooddata-api-client/docs/PublisherDocumentAxisNameDisplay.md new file mode 100644 index 000000000..adcfa9175 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAxisNameDisplay.md @@ -0,0 +1,13 @@ +# PublisherDocumentAxisNameDisplay + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**position** | **str** | | [optional] +**visible** | **bool** | | [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/PublisherDocumentAxisValuesDisplay.md b/gooddata-api-client/docs/PublisherDocumentAxisValuesDisplay.md new file mode 100644 index 000000000..3d1aa5bcb --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentAxisValuesDisplay.md @@ -0,0 +1,13 @@ +# PublisherDocumentAxisValuesDisplay + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rotation** | **float** | Label rotation in degrees, from -90 to 90. | [optional] +**visible** | **bool** | | [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/PublisherDocumentBoundedFilter.md b/gooddata-api-client/docs/PublisherDocumentBoundedFilter.md new file mode 100644 index 000000000..5e05587e6 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentBoundedFilter.md @@ -0,0 +1,15 @@ +# PublisherDocumentBoundedFilter + +One open end of a relative date filter: exactly one of `from` and `to`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**granularity** | **str** | | +**_from** | **int** | | [optional] +**to** | **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/PublisherDocumentChartStyle.md b/gooddata-api-client/docs/PublisherDocumentChartStyle.md new file mode 100644 index 000000000..967f372e8 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentChartStyle.md @@ -0,0 +1,25 @@ +# PublisherDocumentChartStyle + +Chart style overrides; stored, not applied. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**axis_line_color** | **str** | | [optional] +**axis_name_color** | **str** | | [optional] +**axis_name_size** | **float** | | [optional] +**axis_value_color** | **str** | | [optional] +**axis_value_size** | **float** | | [optional] +**data_label_color** | **str** | | [optional] +**data_label_size** | **float** | | [optional] +**font_size** | **float** | | [optional] +**grid_color** | **str** | | [optional] +**legend_color** | **str** | | [optional] +**legend_size** | **float** | | [optional] +**plot_line_color** | **str** | | [optional] +**text_color** | **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/PublisherDocumentColumn.md b/gooddata-api-client/docs/PublisherDocumentColumn.md new file mode 100644 index 000000000..f46127195 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentColumn.md @@ -0,0 +1,18 @@ +# PublisherDocumentColumn + +Lays its children out top to bottom. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**children** | [**[PublisherDocumentLayoutNode]**](PublisherDocumentLayoutNode.md) | Child nodes from top to bottom, in reading order; an empty list is a spacer. | +**type** | **str** | | defaults to "column" +**id** | **str** | | [optional] +**locked** | **bool** | Locks the container in the document editor; never checked on write. | [optional] +**proportion** | **float** | Share of the parent's main axis, greater than 0. Default 1. | [optional] +**style** | [**PublisherDocumentContainerStyle**](PublisherDocumentContainerStyle.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/PublisherDocumentComparisonCondition.md b/gooddata-api-client/docs/PublisherDocumentComparisonCondition.md new file mode 100644 index 000000000..abe7127b4 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentComparisonCondition.md @@ -0,0 +1,12 @@ +# PublisherDocumentComparisonCondition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comparison** | [**DashboardCompoundComparisonConditionComparison**](DashboardCompoundComparisonConditionComparison.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/PublisherDocumentContainerStyle.md b/gooddata-api-client/docs/PublisherDocumentContainerStyle.md new file mode 100644 index 000000000..b3db7d351 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentContainerStyle.md @@ -0,0 +1,69 @@ +# PublisherDocumentContainerStyle + +Style of a row or column; its content inherits the text keys. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**border_bottom_color** | **str** | | [optional] +**border_bottom_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_style** | **str** | | [optional] +**border_bottom_width** | **float** | | [optional] +**border_color** | **str** | | [optional] +**border_left_color** | **str** | | [optional] +**border_left_style** | **str** | | [optional] +**border_left_width** | **float** | | [optional] +**border_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_right_color** | **str** | | [optional] +**border_right_style** | **str** | | [optional] +**border_right_width** | **float** | | [optional] +**border_style** | **str** | | [optional] +**border_top_color** | **str** | | [optional] +**border_top_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_style** | **str** | | [optional] +**border_top_width** | **float** | | [optional] +**border_width** | **float** | | [optional] +**font_size** | **float** | | [optional] +**font_style** | **str** | | [optional] +**font_weight** | **float** | | [optional] +**gap** | [**PublisherDocumentAreaStyleGap**](PublisherDocumentAreaStyleGap.md) | | [optional] +**horizontal_align** | **str** | | [optional] +**letter_spacing** | **float** | | [optional] +**line_height** | **float** | | [optional] +**opacity** | **float** | | [optional] +**padding** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_bottom** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_left** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_right** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_top** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**shadow** | **str** | | [optional] +**shadow_blur** | **float** | | [optional] +**shadow_color** | **str** | | [optional] +**shadow_opacity** | **float** | | [optional] +**shadow_spread** | **float** | | [optional] +**shadow_x** | **float** | | [optional] +**shadow_y** | **float** | | [optional] +**text_color** | **str** | | [optional] +**text_overflow** | **str** | | [optional] +**text_style** | **str** | | [optional] +**text_transform** | **str** | | [optional] +**vertical_align** | **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/PublisherDocumentContainerStyleBorderBottomLeftRadius.md b/gooddata-api-client/docs/PublisherDocumentContainerStyleBorderBottomLeftRadius.md new file mode 100644 index 000000000..7c91704f0 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentContainerStyleBorderBottomLeftRadius.md @@ -0,0 +1,12 @@ +# PublisherDocumentContainerStyleBorderBottomLeftRadius + +A length, or `{theme.corners.}`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/PublisherDocumentContainerStylePadding.md b/gooddata-api-client/docs/PublisherDocumentContainerStylePadding.md new file mode 100644 index 000000000..652915561 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentContainerStylePadding.md @@ -0,0 +1,12 @@ +# PublisherDocumentContainerStylePadding + +A length, or `{theme.spacing.padding.}`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/PublisherDocumentContent.md b/gooddata-api-client/docs/PublisherDocumentContent.md new file mode 100644 index 000000000..3b1e48854 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentContent.md @@ -0,0 +1,20 @@ +# PublisherDocumentContent + +Content of a document or a document template. Holds `pages` or `sections`, never both. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_filter_configs** | [**[PublisherDocumentAttributeFilterConfig]**](PublisherDocumentAttributeFilterConfig.md) | | [optional] +**defaults** | [**PublisherDocumentDefaults**](PublisherDocumentDefaults.md) | | [optional] +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Document filters, at most one per attribute display form or date dataset. | [optional] +**format_locale** | **str** | Locale for formatting dates in variables, charts and tables. | [optional] +**locale** | **str** | Locale of the text the product writes, such as `de-DE`. | [optional] +**pages** | [**[PublisherDocumentPage]**](PublisherDocumentPage.md) | The document's pages, when it has no sections. | [optional] +**sections** | [**[PublisherDocumentSection]**](PublisherDocumentSection.md) | Groups of pages, when the document has no top-level pages. | [optional] +**style** | [**PublisherDocumentAreaStyle**](PublisherDocumentAreaStyle.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/PublisherDocumentDataSetRef.md b/gooddata-api-client/docs/PublisherDocumentDataSetRef.md new file mode 100644 index 000000000..2d9b1b104 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDataSetRef.md @@ -0,0 +1,14 @@ +# PublisherDocumentDataSetRef + +A date dataset. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **str** | | +**type** | **str** | | defaults to "dataSet" +**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/PublisherDocumentDateFilter.md b/gooddata-api-client/docs/PublisherDocumentDateFilter.md new file mode 100644 index 000000000..fa267a8f3 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDateFilter.md @@ -0,0 +1,13 @@ +# PublisherDocumentDateFilter + +Filters a date dataset. A document filter always names its `dataSet`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date_filter** | [**PublisherDocumentDateFilterDateFilter**](PublisherDocumentDateFilterDateFilter.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/PublisherDocumentDateFilterDateFilter.md b/gooddata-api-client/docs/PublisherDocumentDateFilterDateFilter.md new file mode 100644 index 000000000..28b10ca54 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDateFilterDateFilter.md @@ -0,0 +1,20 @@ +# PublisherDocumentDateFilterDateFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**granularity** | **str** | | +**type** | **str** | | +**attribute** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | [optional] +**bounded_filter** | [**PublisherDocumentBoundedFilter**](PublisherDocumentBoundedFilter.md) | | [optional] +**data_set** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | [optional] +**empty_value_handling** | **str** | | [optional] +**_from** | [**PublisherDocumentDateFilterDateFilterFrom**](PublisherDocumentDateFilterDateFilterFrom.md) | | [optional] +**local_identifier** | **str** | Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter. | [optional] +**to** | [**PublisherDocumentDateFilterDateFilterFrom**](PublisherDocumentDateFilterDateFilterFrom.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/PublisherDocumentDateFilterDateFilterFrom.md b/gooddata-api-client/docs/PublisherDocumentDateFilterDateFilterFrom.md new file mode 100644 index 000000000..9527dc159 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDateFilterDateFilterFrom.md @@ -0,0 +1,12 @@ +# PublisherDocumentDateFilterDateFilterFrom + +A date, or an offset of a relative filter. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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/PublisherDocumentDateFilterReference.md b/gooddata-api-client/docs/PublisherDocumentDateFilterReference.md new file mode 100644 index 000000000..337d4732d --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDateFilterReference.md @@ -0,0 +1,13 @@ +# PublisherDocumentDateFilterReference + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_set** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**type** | **str** | | defaults to "dateFilterReference" +**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/PublisherDocumentDefaults.md b/gooddata-api-client/docs/PublisherDocumentDefaults.md new file mode 100644 index 000000000..b3f4f2587 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentDefaults.md @@ -0,0 +1,15 @@ +# PublisherDocumentDefaults + +Document-wide defaults. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page_size** | **str** | Page size of a page that sets none. | [optional] if omitted the server will use the default value of "widescreen" +**period** | [**PublisherDocumentPeriod**](PublisherDocumentPeriod.md) | | [optional] +**takeaway** | [**PublisherDocumentTakeawayDefaults**](PublisherDocumentTakeawayDefaults.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/PublisherDocumentFilter.md b/gooddata-api-client/docs/PublisherDocumentFilter.md new file mode 100644 index 000000000..7711ed32b --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentFilter.md @@ -0,0 +1,17 @@ +# PublisherDocumentFilter + +A filter in the dashboard filter grammar, wrapped in an object keyed by its kind. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_filter** | [**PublisherDocumentAttributeFilterAttributeFilter**](PublisherDocumentAttributeFilterAttributeFilter.md) | | [optional] +**arbitrary_attribute_filter** | [**PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter**](PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter.md) | | [optional] +**match_attribute_filter** | [**PublisherDocumentMatchAttributeFilterMatchAttributeFilter**](PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md) | | [optional] +**date_filter** | [**PublisherDocumentDateFilterDateFilter**](PublisherDocumentDateFilterDateFilter.md) | | [optional] +**dashboard_measure_value_filter** | [**PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter**](PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.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/PublisherDocumentFilterReference.md b/gooddata-api-client/docs/PublisherDocumentFilterReference.md new file mode 100644 index 000000000..234c30865 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentFilterReference.md @@ -0,0 +1,16 @@ +# PublisherDocumentFilterReference + +A reference to a document filter, selected by `type`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "measureValueFilterReference" +**display_form** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | [optional] +**data_set** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | [optional] +**measure** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.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/PublisherDocumentHeadingWidget.md b/gooddata-api-client/docs/PublisherDocumentHeadingWidget.md new file mode 100644 index 000000000..0ada1956d --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentHeadingWidget.md @@ -0,0 +1,20 @@ +# PublisherDocumentHeadingWidget + +A heading below the page title. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "heading" +**level** | **int** | Outline level below the page title. Default 1. | [optional] +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**markdown** | **str** | Inline markdown. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentTextWidgetStyle**](PublisherDocumentTextWidgetStyle.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/PublisherDocumentHeadlineStyle.md b/gooddata-api-client/docs/PublisherDocumentHeadlineStyle.md new file mode 100644 index 000000000..6efcaa874 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentHeadlineStyle.md @@ -0,0 +1,18 @@ +# PublisherDocumentHeadlineStyle + +Headline style overrides; stored, not applied. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**negative_color** | **str** | | [optional] +**positive_color** | **str** | | [optional] +**primary_value_color** | **str** | | [optional] +**primary_value_size** | **float** | | [optional] +**secondary_value_color** | **str** | | [optional] +**secondary_value_size** | **float** | | [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/PublisherDocumentImageWidget.md b/gooddata-api-client/docs/PublisherDocumentImageWidget.md new file mode 100644 index 000000000..7e533a1be --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentImageWidget.md @@ -0,0 +1,21 @@ +# PublisherDocumentImageWidget + +An image from the theme or an https URL. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "image" +**alt_text** | **str** | | [optional] +**decorative** | **bool** | Left out of the accessibility tree, PDF tags and the AI context; needs no alt text. | [optional] +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**source** | **str** | A theme image reference such as `{theme.logo}`, or an `https://` URL. | [optional] +**style** | [**PublisherDocumentImageWidgetStyle**](PublisherDocumentImageWidgetStyle.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/PublisherDocumentImageWidgetStyle.md b/gooddata-api-client/docs/PublisherDocumentImageWidgetStyle.md new file mode 100644 index 000000000..8592cfbdc --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentImageWidgetStyle.md @@ -0,0 +1,60 @@ +# PublisherDocumentImageWidgetStyle + +Style of an image widget. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**border_bottom_color** | **str** | | [optional] +**border_bottom_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_style** | **str** | | [optional] +**border_bottom_width** | **float** | | [optional] +**border_color** | **str** | | [optional] +**border_left_color** | **str** | | [optional] +**border_left_style** | **str** | | [optional] +**border_left_width** | **float** | | [optional] +**border_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_right_color** | **str** | | [optional] +**border_right_style** | **str** | | [optional] +**border_right_width** | **float** | | [optional] +**border_style** | **str** | | [optional] +**border_top_color** | **str** | | [optional] +**border_top_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_style** | **str** | | [optional] +**border_top_width** | **float** | | [optional] +**border_width** | **float** | | [optional] +**fit** | **str** | | [optional] +**horizontal_align** | **str** | | [optional] +**opacity** | **float** | | [optional] +**padding** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_bottom** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_left** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_right** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_top** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**shadow** | **str** | | [optional] +**shadow_blur** | **float** | | [optional] +**shadow_color** | **str** | | [optional] +**shadow_opacity** | **float** | | [optional] +**shadow_spread** | **float** | | [optional] +**shadow_x** | **float** | | [optional] +**shadow_y** | **float** | | [optional] +**vertical_align** | **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/PublisherDocumentLayoutNode.md b/gooddata-api-client/docs/PublisherDocumentLayoutNode.md new file mode 100644 index 000000000..23bfffdf1 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentLayoutNode.md @@ -0,0 +1,32 @@ +# PublisherDocumentLayoutNode + +A layout node: a row or column container, or a widget. The shape is selected by `type`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | defaults to "takeaway" +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentTextWidgetStyle**](PublisherDocumentTextWidgetStyle.md) | | [optional] +**markdown** | **str** | The generated text. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**level** | **int** | Outline level below the page title. Default 1. | [optional] +**decorative** | **bool** | Left out of the accessibility tree, PDF tags and the AI context; needs no alt text. | [optional] +**alt_text** | **str** | Defaults to the visualization's description. | [optional] +**source** | **str** | A theme image reference such as `{theme.logo}`, or an `https://` URL. | [optional] +**date_data_set** | [**PublisherDocumentDataSetRef**](PublisherDocumentDataSetRef.md) | | [optional] +**display** | [**PublisherDocumentVisualizationDisplay**](PublisherDocumentVisualizationDisplay.md) | | [optional] +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Widget filters; stored, not applied. | [optional] +**ignore_document_filters** | [**[PublisherDocumentFilterReference]**](PublisherDocumentFilterReference.md) | Document filters this widget ignores. | [optional] +**ignore_document_period** | **bool** | | [optional] +**title** | [**PublisherDocumentWidgetTitle**](PublisherDocumentWidgetTitle.md) | | [optional] +**visualization** | [**PublisherDocumentVisualizationRef**](PublisherDocumentVisualizationRef.md) | | [optional] +**generation** | [**PublisherDocumentTakeawayGeneration**](PublisherDocumentTakeawayGeneration.md) | | [optional] +**children** | [**[PublisherDocumentLayoutNode]**](PublisherDocumentLayoutNode.md) | Child nodes from top to bottom, in reading order; an empty list is a spacer. | [optional] +**id** | **str** | Unique within the page. | [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/PublisherDocumentLegendDisplay.md b/gooddata-api-client/docs/PublisherDocumentLegendDisplay.md new file mode 100644 index 000000000..ce366b197 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentLegendDisplay.md @@ -0,0 +1,13 @@ +# PublisherDocumentLegendDisplay + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**position** | **str** | | [optional] +**visible** | **bool** | | [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/PublisherDocumentMatchAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentMatchAttributeFilter.md new file mode 100644 index 000000000..0d041f0b7 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMatchAttributeFilter.md @@ -0,0 +1,13 @@ +# PublisherDocumentMatchAttributeFilter + +Filters an attribute display form by a text pattern. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**match_attribute_filter** | [**PublisherDocumentMatchAttributeFilterMatchAttributeFilter**](PublisherDocumentMatchAttributeFilterMatchAttributeFilter.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/PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md b/gooddata-api-client/docs/PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md new file mode 100644 index 000000000..49a189cee --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMatchAttributeFilterMatchAttributeFilter.md @@ -0,0 +1,18 @@ +# PublisherDocumentMatchAttributeFilterMatchAttributeFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**display_form** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**literal** | **str** | | +**operator** | **str** | | +**case_sensitive** | **bool** | | [optional] +**local_identifier** | **str** | Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter. | [optional] +**negative_selection** | **bool** | | [optional] +**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/PublisherDocumentMeasureValueCondition.md b/gooddata-api-client/docs/PublisherDocumentMeasureValueCondition.md new file mode 100644 index 000000000..ceace9dad --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMeasureValueCondition.md @@ -0,0 +1,14 @@ +# PublisherDocumentMeasureValueCondition + +A measure value condition, wrapped in an object keyed by its kind. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comparison** | [**DashboardCompoundComparisonConditionComparison**](DashboardCompoundComparisonConditionComparison.md) | | [optional] +**range** | [**DashboardCompoundRangeConditionRange**](DashboardCompoundRangeConditionRange.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/PublisherDocumentMeasureValueFilter.md b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilter.md new file mode 100644 index 000000000..5ff6211f2 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilter.md @@ -0,0 +1,13 @@ +# PublisherDocumentMeasureValueFilter + +Filters by the value of a measure. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dashboard_measure_value_filter** | [**PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter**](PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.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/PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.md b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.md new file mode 100644 index 000000000..064b42898 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter.md @@ -0,0 +1,16 @@ +# PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**local_identifier** | **str** | | +**measure** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**conditions** | [**[PublisherDocumentMeasureValueCondition]**](PublisherDocumentMeasureValueCondition.md) | OR-ed conditions; none means all values. | [optional] +**dimensionality** | [**[PublisherDocumentObjRef]**](PublisherDocumentObjRef.md) | | [optional] +**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/PublisherDocumentMeasureValueFilterReference.md b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilterReference.md new file mode 100644 index 000000000..66c7a8528 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentMeasureValueFilterReference.md @@ -0,0 +1,13 @@ +# PublisherDocumentMeasureValueFilterReference + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**measure** | [**PublisherDocumentObjRef**](PublisherDocumentObjRef.md) | | +**type** | **str** | | defaults to "measureValueFilterReference" +**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/PublisherDocumentObjRef.md b/gooddata-api-client/docs/PublisherDocumentObjRef.md new file mode 100644 index 000000000..009ccceaf --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentObjRef.md @@ -0,0 +1,14 @@ +# PublisherDocumentObjRef + +A flat object reference. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **str** | | +**type** | **str** | sdk-model object type, such as `displayForm`, `dataSet` or `measure`. | +**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/PublisherDocumentPage.md b/gooddata-api-client/docs/PublisherDocumentPage.md new file mode 100644 index 000000000..1b8116363 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentPage.md @@ -0,0 +1,20 @@ +# PublisherDocumentPage + +A page of a document. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**layout** | [**PublisherDocumentLayoutNode**](PublisherDocumentLayoutNode.md) | | +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Page filters; stored, not applied. | [optional] +**id** | **str** | Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it. | [optional] +**kind** | **str** | Editor hint. | [optional] +**notes** | **str** | Speaker notes in markdown, never drawn. | [optional] +**page_size** | **str** | | [optional] if omitted the server will use the default value of "widescreen" +**style** | [**PublisherDocumentPageStyle**](PublisherDocumentPageStyle.md) | | [optional] +**visible** | **bool** | `false` keeps the page out of the viewer, exports and page numbering. Default `true`. | [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/PublisherDocumentPageStyle.md b/gooddata-api-client/docs/PublisherDocumentPageStyle.md new file mode 100644 index 000000000..e12f68643 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentPageStyle.md @@ -0,0 +1,41 @@ +# PublisherDocumentPageStyle + +Style of a page; containers inherit its gap and text keys. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**font_size** | **float** | | [optional] +**font_style** | **str** | | [optional] +**font_weight** | **float** | | [optional] +**gap** | [**PublisherDocumentAreaStyleGap**](PublisherDocumentAreaStyleGap.md) | | [optional] +**horizontal_align** | **str** | | [optional] +**letter_spacing** | **float** | | [optional] +**line_height** | **float** | | [optional] +**padding** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_bottom** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_left** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_right** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_top** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**text_color** | **str** | | [optional] +**text_overflow** | **str** | | [optional] +**text_style** | **str** | | [optional] +**text_transform** | **str** | | [optional] +**vertical_align** | **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/PublisherDocumentPageTemplateContent.md b/gooddata-api-client/docs/PublisherDocumentPageTemplateContent.md new file mode 100644 index 000000000..15c8edcaf --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentPageTemplateContent.md @@ -0,0 +1,18 @@ +# PublisherDocumentPageTemplateContent + +Content of a page template: one page without `id` and `visible`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**layout** | [**PublisherDocumentLayoutNode**](PublisherDocumentLayoutNode.md) | | +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Page filters; stored, not applied. | [optional] +**kind** | **str** | Editor hint. | [optional] +**notes** | **str** | Speaker notes in markdown, never drawn. | [optional] +**page_size** | **str** | | [optional] if omitted the server will use the default value of "widescreen" +**style** | [**PublisherDocumentPageStyle**](PublisherDocumentPageStyle.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/PublisherDocumentPeriod.md b/gooddata-api-client/docs/PublisherDocumentPeriod.md new file mode 100644 index 000000000..02b0f482b --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentPeriod.md @@ -0,0 +1,16 @@ +# PublisherDocumentPeriod + +The period the document covers, absolute or relative to today. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | Type of the period. | defaults to "relative" +**_from** | **int** | Start of the period, in units relative to the current one. | [optional] +**granularity** | **str** | Date granularity of the period. | [optional] +**to** | **int** | End of the period, in units relative to the current one. | [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/PublisherDocumentRangeCondition.md b/gooddata-api-client/docs/PublisherDocumentRangeCondition.md new file mode 100644 index 000000000..3fb5099fa --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentRangeCondition.md @@ -0,0 +1,12 @@ +# PublisherDocumentRangeCondition + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**range** | [**DashboardCompoundRangeConditionRange**](DashboardCompoundRangeConditionRange.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/PublisherDocumentRow.md b/gooddata-api-client/docs/PublisherDocumentRow.md new file mode 100644 index 000000000..23acebac7 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentRow.md @@ -0,0 +1,18 @@ +# PublisherDocumentRow + +Lays its children out left to right. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**children** | [**[PublisherDocumentLayoutNode]**](PublisherDocumentLayoutNode.md) | Child nodes from left to right, in reading order; an empty list is a spacer. | +**type** | **str** | | defaults to "row" +**id** | **str** | | [optional] +**locked** | **bool** | Locks the container in the document editor; never checked on write. | [optional] +**proportion** | **float** | Share of the parent's main axis, greater than 0. Default 1. | [optional] +**style** | [**PublisherDocumentContainerStyle**](PublisherDocumentContainerStyle.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/PublisherDocumentSection.md b/gooddata-api-client/docs/PublisherDocumentSection.md new file mode 100644 index 000000000..d8a6b0db9 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentSection.md @@ -0,0 +1,16 @@ +# PublisherDocumentSection + +A group of pages, like a dashboard tab. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pages** | [**[PublisherDocumentPage]**](PublisherDocumentPage.md) | | +**description** | **str** | | [optional] +**id** | **str** | Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it. | [optional] +**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/PublisherDocumentTableStyle.md b/gooddata-api-client/docs/PublisherDocumentTableStyle.md new file mode 100644 index 000000000..39227de46 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTableStyle.md @@ -0,0 +1,22 @@ +# PublisherDocumentTableStyle + +Table style overrides; stored, not applied. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**font_size** | **float** | | [optional] +**grid_color** | **str** | | [optional] +**header_background_color** | **str** | | [optional] +**header_label_color** | **str** | | [optional] +**null_value_color** | **str** | | [optional] +**row_height** | **float** | | [optional] +**subtotal_background_color** | **str** | | [optional] +**total_background_color** | **str** | | [optional] +**total_value_color** | **str** | | [optional] +**value_color** | **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/PublisherDocumentTakeawayContext.md b/gooddata-api-client/docs/PublisherDocumentTakeawayContext.md new file mode 100644 index 000000000..a0230fdaf --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTakeawayContext.md @@ -0,0 +1,16 @@ +# PublisherDocumentTakeawayContext + +What the copilot reads when it writes a takeaway. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **bool** | | [optional] +**other_pages** | **bool** | | [optional] +**page_title** | **bool** | | [optional] +**widgets** | **[str]** | Widget ids on the same page. | [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/PublisherDocumentTakeawayDefaults.md b/gooddata-api-client/docs/PublisherDocumentTakeawayDefaults.md new file mode 100644 index 000000000..c19cd4f7a --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTakeawayDefaults.md @@ -0,0 +1,13 @@ +# PublisherDocumentTakeawayDefaults + +Takeaway settings every takeaway widget of the document uses. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**generation** | [**PublisherDocumentTakeawayGeneration**](PublisherDocumentTakeawayGeneration.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/PublisherDocumentTakeawayGeneration.md b/gooddata-api-client/docs/PublisherDocumentTakeawayGeneration.md new file mode 100644 index 000000000..37bd363c3 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTakeawayGeneration.md @@ -0,0 +1,14 @@ +# PublisherDocumentTakeawayGeneration + +How the copilot writes a takeaway. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | [**PublisherDocumentTakeawayContext**](PublisherDocumentTakeawayContext.md) | | [optional] +**instructions** | **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/PublisherDocumentTakeawayWidget.md b/gooddata-api-client/docs/PublisherDocumentTakeawayWidget.md new file mode 100644 index 000000000..41097a31d --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTakeawayWidget.md @@ -0,0 +1,21 @@ +# PublisherDocumentTakeawayWidget + +A generated takeaway, stored as markdown. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "takeaway" +**generation** | [**PublisherDocumentTakeawayGeneration**](PublisherDocumentTakeawayGeneration.md) | | [optional] +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**markdown** | **str** | The generated text. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentTextWidgetStyle**](PublisherDocumentTextWidgetStyle.md) | | [optional] +**title** | [**PublisherDocumentWidgetTitle**](PublisherDocumentWidgetTitle.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/PublisherDocumentTextStyle.md b/gooddata-api-client/docs/PublisherDocumentTextStyle.md new file mode 100644 index 000000000..f96b02b53 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTextStyle.md @@ -0,0 +1,23 @@ +# PublisherDocumentTextStyle + +Text style of a widget title. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**font_size** | **float** | | [optional] +**font_style** | **str** | | [optional] +**font_weight** | **float** | | [optional] +**horizontal_align** | **str** | | [optional] +**letter_spacing** | **float** | | [optional] +**line_height** | **float** | | [optional] +**text_color** | **str** | | [optional] +**text_overflow** | **str** | | [optional] +**text_style** | **str** | | [optional] +**text_transform** | **str** | | [optional] +**vertical_align** | **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/PublisherDocumentTextWidget.md b/gooddata-api-client/docs/PublisherDocumentTextWidget.md new file mode 100644 index 000000000..43652d356 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTextWidget.md @@ -0,0 +1,20 @@ +# PublisherDocumentTextWidget + +A block of markdown text. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "text" +**decorative** | **bool** | Left out of the accessibility tree, PDF tags and the AI context. | [optional] +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**markdown** | **str** | Full markdown. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentTextWidgetStyle**](PublisherDocumentTextWidgetStyle.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/PublisherDocumentTextWidgetStyle.md b/gooddata-api-client/docs/PublisherDocumentTextWidgetStyle.md new file mode 100644 index 000000000..886758f1f --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTextWidgetStyle.md @@ -0,0 +1,68 @@ +# PublisherDocumentTextWidgetStyle + +Style of a title, heading, text or takeaway widget. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**border_bottom_color** | **str** | | [optional] +**border_bottom_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_style** | **str** | | [optional] +**border_bottom_width** | **float** | | [optional] +**border_color** | **str** | | [optional] +**border_left_color** | **str** | | [optional] +**border_left_style** | **str** | | [optional] +**border_left_width** | **float** | | [optional] +**border_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_right_color** | **str** | | [optional] +**border_right_style** | **str** | | [optional] +**border_right_width** | **float** | | [optional] +**border_style** | **str** | | [optional] +**border_top_color** | **str** | | [optional] +**border_top_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_style** | **str** | | [optional] +**border_top_width** | **float** | | [optional] +**border_width** | **float** | | [optional] +**font_size** | **float** | | [optional] +**font_style** | **str** | | [optional] +**font_weight** | **float** | | [optional] +**horizontal_align** | **str** | | [optional] +**letter_spacing** | **float** | | [optional] +**line_height** | **float** | | [optional] +**opacity** | **float** | | [optional] +**padding** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_bottom** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_left** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_right** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_top** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**shadow** | **str** | | [optional] +**shadow_blur** | **float** | | [optional] +**shadow_color** | **str** | | [optional] +**shadow_opacity** | **float** | | [optional] +**shadow_spread** | **float** | | [optional] +**shadow_x** | **float** | | [optional] +**shadow_y** | **float** | | [optional] +**text_color** | **str** | | [optional] +**text_overflow** | **str** | | [optional] +**text_style** | **str** | | [optional] +**text_transform** | **str** | | [optional] +**vertical_align** | **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/PublisherDocumentTitleWidget.md b/gooddata-api-client/docs/PublisherDocumentTitleWidget.md new file mode 100644 index 000000000..12ba7bfee --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentTitleWidget.md @@ -0,0 +1,19 @@ +# PublisherDocumentTitleWidget + +The page's title, at most one per page. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "title" +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**markdown** | **str** | Inline markdown. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentTextWidgetStyle**](PublisherDocumentTextWidgetStyle.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/PublisherDocumentVisibility.md b/gooddata-api-client/docs/PublisherDocumentVisibility.md new file mode 100644 index 000000000..42d8bf586 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentVisibility.md @@ -0,0 +1,12 @@ +# PublisherDocumentVisibility + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visible** | **bool** | | [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/PublisherDocumentVisualizationDisplay.md b/gooddata-api-client/docs/PublisherDocumentVisualizationDisplay.md new file mode 100644 index 000000000..933d3fad8 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentVisualizationDisplay.md @@ -0,0 +1,19 @@ +# PublisherDocumentVisualizationDisplay + +Overrides of the saved visualization's own configuration; stored, not applied. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_labels** | [**PublisherDocumentAutoVisibility**](PublisherDocumentAutoVisibility.md) | | [optional] +**data_points** | [**PublisherDocumentAutoVisibility**](PublisherDocumentAutoVisibility.md) | | [optional] +**gridlines** | [**PublisherDocumentVisibility**](PublisherDocumentVisibility.md) | | [optional] +**legend** | [**PublisherDocumentLegendDisplay**](PublisherDocumentLegendDisplay.md) | | [optional] +**secondary_y_axis** | [**PublisherDocumentAxisDisplay**](PublisherDocumentAxisDisplay.md) | | [optional] +**x_axis** | [**PublisherDocumentAxisDisplay**](PublisherDocumentAxisDisplay.md) | | [optional] +**y_axis** | [**PublisherDocumentAxisDisplay**](PublisherDocumentAxisDisplay.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/PublisherDocumentVisualizationRef.md b/gooddata-api-client/docs/PublisherDocumentVisualizationRef.md new file mode 100644 index 000000000..b3197ca0e --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentVisualizationRef.md @@ -0,0 +1,14 @@ +# PublisherDocumentVisualizationRef + +A saved visualization. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **str** | | +**type** | **str** | | defaults to "insight" +**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/PublisherDocumentVisualizationStyle.md b/gooddata-api-client/docs/PublisherDocumentVisualizationStyle.md new file mode 100644 index 000000000..142271030 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentVisualizationStyle.md @@ -0,0 +1,60 @@ +# PublisherDocumentVisualizationStyle + +Style of a visualization widget. Lengths are in canvas px. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**background_color** | **str** | | [optional] +**background_fit** | **str** | | [optional] +**background_horizontal_align** | **str** | | [optional] +**background_image** | **str** | | [optional] +**background_image_opacity** | **float** | | [optional] +**background_offset** | **float** | | [optional] +**background_offset_bottom** | **float** | | [optional] +**background_offset_left** | **float** | | [optional] +**background_offset_right** | **float** | | [optional] +**background_offset_top** | **float** | | [optional] +**background_opacity** | **float** | | [optional] +**background_vertical_align** | **str** | | [optional] +**border_bottom_color** | **str** | | [optional] +**border_bottom_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_bottom_style** | **str** | | [optional] +**border_bottom_width** | **float** | | [optional] +**border_color** | **str** | | [optional] +**border_left_color** | **str** | | [optional] +**border_left_style** | **str** | | [optional] +**border_left_width** | **float** | | [optional] +**border_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_right_color** | **str** | | [optional] +**border_right_style** | **str** | | [optional] +**border_right_width** | **float** | | [optional] +**border_style** | **str** | | [optional] +**border_top_color** | **str** | | [optional] +**border_top_left_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_right_radius** | [**PublisherDocumentContainerStyleBorderBottomLeftRadius**](PublisherDocumentContainerStyleBorderBottomLeftRadius.md) | | [optional] +**border_top_style** | **str** | | [optional] +**border_top_width** | **float** | | [optional] +**border_width** | **float** | | [optional] +**chart** | [**PublisherDocumentChartStyle**](PublisherDocumentChartStyle.md) | | [optional] +**headline** | [**PublisherDocumentHeadlineStyle**](PublisherDocumentHeadlineStyle.md) | | [optional] +**opacity** | **float** | | [optional] +**padding** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_bottom** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_left** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_right** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**padding_top** | [**PublisherDocumentContainerStylePadding**](PublisherDocumentContainerStylePadding.md) | | [optional] +**shadow** | **str** | | [optional] +**shadow_blur** | **float** | | [optional] +**shadow_color** | **str** | | [optional] +**shadow_opacity** | **float** | | [optional] +**shadow_spread** | **float** | | [optional] +**shadow_x** | **float** | | [optional] +**shadow_y** | **float** | | [optional] +**table** | [**PublisherDocumentTableStyle**](PublisherDocumentTableStyle.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/PublisherDocumentVisualizationWidget.md b/gooddata-api-client/docs/PublisherDocumentVisualizationWidget.md new file mode 100644 index 000000000..957b387ed --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentVisualizationWidget.md @@ -0,0 +1,26 @@ +# PublisherDocumentVisualizationWidget + +A saved visualization. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique within the page. | +**type** | **str** | | defaults to "visualization" +**alt_text** | **str** | Defaults to the visualization's description. | [optional] +**date_data_set** | [**PublisherDocumentDataSetRef**](PublisherDocumentDataSetRef.md) | | [optional] +**display** | [**PublisherDocumentVisualizationDisplay**](PublisherDocumentVisualizationDisplay.md) | | [optional] +**filters** | [**[PublisherDocumentFilter]**](PublisherDocumentFilter.md) | Widget filters; stored, not applied. | [optional] +**ignore_document_filters** | [**[PublisherDocumentFilterReference]**](PublisherDocumentFilterReference.md) | Document filters this widget ignores. | [optional] +**ignore_document_period** | **bool** | | [optional] +**locked** | **bool** | Locks the widget in the document editor; never checked on write. | [optional] +**placeholder** | [**PublisherDocumentWidgetPlaceholder**](PublisherDocumentWidgetPlaceholder.md) | | [optional] +**proportion** | **float** | | [optional] +**style** | [**PublisherDocumentVisualizationStyle**](PublisherDocumentVisualizationStyle.md) | | [optional] +**title** | [**PublisherDocumentWidgetTitle**](PublisherDocumentWidgetTitle.md) | | [optional] +**visualization** | [**PublisherDocumentVisualizationRef**](PublisherDocumentVisualizationRef.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/PublisherDocumentWidgetPlaceholder.md b/gooddata-api-client/docs/PublisherDocumentWidgetPlaceholder.md new file mode 100644 index 000000000..78b622b8e --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentWidgetPlaceholder.md @@ -0,0 +1,14 @@ +# PublisherDocumentWidgetPlaceholder + +What the editor shows in an empty widget. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hint** | **str** | | [optional] +**required** | **bool** | | [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/PublisherDocumentWidgetTitle.md b/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md new file mode 100644 index 000000000..b20b4ca65 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentWidgetTitle.md @@ -0,0 +1,15 @@ +# PublisherDocumentWidgetTitle + +Title of a visualization or takeaway widget. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**style** | [**PublisherDocumentTextStyle**](PublisherDocumentTextStyle.md) | | [optional] +**text** | **str** | Overrides the default title; may contain text variables. | [optional] +**visible** | **bool** | Default `true`. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/PublisherDocumentsApi.md b/gooddata-api-client/docs/PublisherDocumentsApi.md new file mode 100644 index 000000000..0b6247f94 --- /dev/null +++ b/gooddata-api-client/docs/PublisherDocumentsApi.md @@ -0,0 +1,2657 @@ +# gooddata_api_client.PublisherDocumentsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_document_templates**](PublisherDocumentsApi.md#create_entity_document_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Post Document Template +[**create_entity_documents**](PublisherDocumentsApi.md#create_entity_documents) | **POST** /api/v1/entities/workspaces/{workspaceId}/documents | Post Document +[**create_entity_page_templates**](PublisherDocumentsApi.md#create_entity_page_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Post Page Template +[**delete_entity_document_templates**](PublisherDocumentsApi.md#delete_entity_document_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Delete a Document Template +[**delete_entity_documents**](PublisherDocumentsApi.md#delete_entity_documents) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Delete a Document +[**delete_entity_page_templates**](PublisherDocumentsApi.md#delete_entity_page_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Delete a Page Template +[**get_all_entities_document_templates**](PublisherDocumentsApi.md#get_all_entities_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates | Get all Document Templates +[**get_all_entities_documents**](PublisherDocumentsApi.md#get_all_entities_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents | Get all Documents +[**get_all_entities_page_templates**](PublisherDocumentsApi.md#get_all_entities_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates | Get all Page Templates +[**get_entity_document_templates**](PublisherDocumentsApi.md#get_entity_document_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Get a Document Template +[**get_entity_documents**](PublisherDocumentsApi.md#get_entity_documents) | **GET** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Get a Document +[**get_entity_page_templates**](PublisherDocumentsApi.md#get_entity_page_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Get a Page Template +[**patch_entity_document_templates**](PublisherDocumentsApi.md#patch_entity_document_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Patch a Document Template +[**patch_entity_documents**](PublisherDocumentsApi.md#patch_entity_documents) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Patch a Document +[**patch_entity_page_templates**](PublisherDocumentsApi.md#patch_entity_page_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Patch a Page Template +[**update_entity_document_templates**](PublisherDocumentsApi.md#update_entity_document_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId} | Put a Document Template +[**update_entity_documents**](PublisherDocumentsApi.md#update_entity_documents) | **PUT** /api/v1/entities/workspaces/{workspaceId}/documents/{objectId} | Put a Document +[**update_entity_page_templates**](PublisherDocumentsApi.md#update_entity_page_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId} | Put a Page Template + + +# **create_entity_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + +Post Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_template_post_optional_id_document = JsonApiPublisherDocumentTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document Template + api_response = api_instance.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_template_post_optional_id_document** | [**JsonApiPublisherDocumentTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + +Post Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_post_optional_id_document = JsonApiPublisherDocumentPostOptionalIdDocument( + data=JsonApiPublisherDocumentPostOptionalId( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentPostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Document + api_response = api_instance.create_entity_documents(workspace_id, json_api_publisher_document_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_post_optional_id_document** | [**JsonApiPublisherDocumentPostOptionalIdDocument**](JsonApiPublisherDocumentPostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + +Post Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_publisher_document_page_template_post_optional_id_document = JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument( + data=JsonApiPublisherDocumentPageTemplatePostOptionalId( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument | + 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) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Page Template + api_response = api_instance.create_entity_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->create_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_publisher_document_page_template_post_optional_id_document** | [**JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument**](JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument.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] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_document_templates** +> delete_entity_document_templates(workspace_id, object_id) + +Delete a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_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 = publisher_documents_api.PublisherDocumentsApi(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 Document Template + api_instance.delete_entity_document_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->delete_entity_document_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_documents** +> delete_entity_documents(workspace_id, object_id) + +Delete a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_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 = publisher_documents_api.PublisherDocumentsApi(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 Document + api_instance.delete_entity_documents(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->delete_entity_documents: %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_page_templates** +> delete_entity_page_templates(workspace_id, object_id) + +Delete a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_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 = publisher_documents_api.PublisherDocumentsApi(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 Page Template + api_instance.delete_entity_page_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->delete_entity_page_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_document_templates** +> JsonApiPublisherDocumentTemplateOutList get_all_entities_document_templates(workspace_id) + +Get all Document Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Document Templates + api_response = api_instance.get_all_entities_document_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_all_entities_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Document Templates + api_response = api_instance.get_all_entities_document_templates(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 PublisherDocumentsApi->get_all_entities_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutList**](JsonApiPublisherDocumentTemplateOutList.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_documents** +> JsonApiPublisherDocumentOutList get_all_entities_documents(workspace_id) + +Get all Documents + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Documents + api_response = api_instance.get_all_entities_documents(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_all_entities_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Documents + api_response = api_instance.get_all_entities_documents(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 PublisherDocumentsApi->get_all_entities_documents: %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] + **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 + +[**JsonApiPublisherDocumentOutList**](JsonApiPublisherDocumentOutList.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutList get_all_entities_page_templates(workspace_id) + +Get all Page Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "version==someString;title==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) + 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 Page Templates + api_response = api_instance.get_all_entities_page_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_all_entities_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Page Templates + api_response = api_instance.get_all_entities_page_templates(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 PublisherDocumentsApi->get_all_entities_page_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] + **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 + +[**JsonApiPublisherDocumentPageTemplateOutList**](JsonApiPublisherDocumentPageTemplateOutList.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument get_entity_document_templates(workspace_id, object_id) + +Get a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document Template + api_response = api_instance.get_entity_document_templates(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 PublisherDocumentsApi->get_entity_document_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] + **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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument get_entity_documents(workspace_id, object_id) + +Get a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Document + api_response = api_instance.get_entity_documents(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Document + api_response = api_instance.get_entity_documents(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 PublisherDocumentsApi->get_entity_documents: %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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument get_entity_page_templates(workspace_id, object_id) + +Get a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "version==someString;title==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: + # Get a Page Template + api_response = api_instance.get_entity_page_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->get_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Page Template + api_response = api_instance.get_entity_page_templates(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 PublisherDocumentsApi->get_entity_page_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] + **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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) + +Patch a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_template_patch_document = JsonApiPublisherDocumentTemplatePatchDocument( + data=JsonApiPublisherDocumentTemplatePatch( + attributes=JsonApiPublisherDocumentTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplatePatchDocument | + filter = "version==someString;title==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 a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Document Template + api_response = api_instance.patch_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_template_patch_document** | [**JsonApiPublisherDocumentTemplatePatchDocument**](JsonApiPublisherDocumentTemplatePatchDocument.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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) + +Patch a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_patch_document = JsonApiPublisherDocumentPatchDocument( + data=JsonApiPublisherDocumentPatch( + attributes=JsonApiPublisherDocumentPatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentPatchDocument | + filter = "version==someString;title==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 a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Document + api_response = api_instance.patch_entity_documents(workspace_id, object_id, json_api_publisher_document_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_patch_document** | [**JsonApiPublisherDocumentPatchDocument**](JsonApiPublisherDocumentPatchDocument.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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) + +Patch a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_page_template_patch_document = JsonApiPublisherDocumentPageTemplatePatchDocument( + data=JsonApiPublisherDocumentPageTemplatePatch( + attributes=JsonApiPublisherDocumentPageTemplatePatchAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplatePatchDocument | + filter = "version==someString;title==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 a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Page Template + api_response = api_instance.patch_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->patch_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_patch_document** | [**JsonApiPublisherDocumentPageTemplatePatchDocument**](JsonApiPublisherDocumentPageTemplatePatchDocument.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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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_document_templates** +> JsonApiPublisherDocumentTemplateOutDocument update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) + +Put a Document Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_template_in_document = JsonApiPublisherDocumentTemplateInDocument( + data=JsonApiPublisherDocumentTemplateIn( + attributes=JsonApiPublisherDocumentTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentTemplateInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="documentTemplate", + ), + ) # JsonApiPublisherDocumentTemplateInDocument | + filter = "version==someString;title==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 a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_document_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Document Template + api_response = api_instance.update_entity_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_document_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_template_in_document** | [**JsonApiPublisherDocumentTemplateInDocument**](JsonApiPublisherDocumentTemplateInDocument.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 + +[**JsonApiPublisherDocumentTemplateOutDocument**](JsonApiPublisherDocumentTemplateOutDocument.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_documents** +> JsonApiPublisherDocumentOutDocument update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) + +Put a Document + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_in_document = JsonApiPublisherDocumentInDocument( + data=JsonApiPublisherDocumentIn( + attributes=JsonApiPublisherDocumentInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentInAttributesContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + period=JsonApiPublisherDocumentInAttributesPeriod(), + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="document", + ), + ) # JsonApiPublisherDocumentInDocument | + filter = "version==someString;title==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 a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_documents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Document + api_response = api_instance.update_entity_documents(workspace_id, object_id, json_api_publisher_document_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_documents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_in_document** | [**JsonApiPublisherDocumentInDocument**](JsonApiPublisherDocumentInDocument.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 + +[**JsonApiPublisherDocumentOutDocument**](JsonApiPublisherDocumentOutDocument.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_page_templates** +> JsonApiPublisherDocumentPageTemplateOutDocument update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + +Put a Page Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import publisher_documents_api +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = publisher_documents_api.PublisherDocumentsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_publisher_document_page_template_in_document = JsonApiPublisherDocumentPageTemplateInDocument( + data=JsonApiPublisherDocumentPageTemplateIn( + attributes=JsonApiPublisherDocumentPageTemplateInAttributes( + are_relations_valid=True, + content=JsonApiPublisherDocumentPageTemplateInAttributesContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + version="2", + ), + id="id1", + type="pageTemplate", + ), + ) # JsonApiPublisherDocumentPageTemplateInDocument | + filter = "version==someString;title==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 a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_page_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Page Template + api_response = api_instance.update_entity_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PublisherDocumentsApi->update_entity_page_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_publisher_document_page_template_in_document** | [**JsonApiPublisherDocumentPageTemplateInDocument**](JsonApiPublisherDocumentPageTemplateInDocument.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 + +[**JsonApiPublisherDocumentPageTemplateOutDocument**](JsonApiPublisherDocumentPageTemplateOutDocument.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/RelativePublisherDocumentPeriod.md b/gooddata-api-client/docs/RelativePublisherDocumentPeriod.md new file mode 100644 index 000000000..47b964555 --- /dev/null +++ b/gooddata-api-client/docs/RelativePublisherDocumentPeriod.md @@ -0,0 +1,16 @@ +# RelativePublisherDocumentPeriod + +A period counted in granularity units from the current one, which is 0. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **int** | Start of the period, in units relative to the current one. | +**granularity** | **str** | Date granularity of the period. | +**to** | **int** | End of the period, in units relative to the current one. | +**type** | **str** | | defaults to "relative" +**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/RelativePublisherDocumentPeriodAllOf.md b/gooddata-api-client/docs/RelativePublisherDocumentPeriodAllOf.md new file mode 100644 index 000000000..eb64e3c2e --- /dev/null +++ b/gooddata-api-client/docs/RelativePublisherDocumentPeriodAllOf.md @@ -0,0 +1,15 @@ +# RelativePublisherDocumentPeriodAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **int** | Start of the period, in units relative to the current one. | [optional] +**granularity** | **str** | Date granularity of the period. | [optional] +**to** | **int** | End of the period, in units relative to the current one. | [optional] +**type** | **str** | Type of the period. | [optional] if omitted the server will use the default value of "relative" +**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/ReportExportApi.md b/gooddata-api-client/docs/ReportExportApi.md index 5137a4de6..02177c7d4 100644 --- a/gooddata-api-client/docs/ReportExportApi.md +++ b/gooddata-api-client/docs/ReportExportApi.md @@ -4,17 +4,108 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- +[**create_document_export**](ReportExportApi.md#create_document_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/document | (EXPERIMENTAL) Create document export request [**create_report_export**](ReportExportApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request +[**get_document_export**](ReportExportApi.md#get_document_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId} | (EXPERIMENTAL) Retrieve exported document +[**get_document_export_metadata**](ReportExportApi.md#get_document_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata | (EXPERIMENTAL) Retrieve document export metadata [**get_report_export**](ReportExportApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files [**get_report_export_metadata**](ReportExportApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context +# **create_document_export** +> ExportResponse create_document_export(workspace_id, report_export_request) + +(EXPERIMENTAL) Create document export request + +Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_export_api +from gooddata_api_client.model.export_response import ExportResponse +from gooddata_api_client.model.report_export_request import ReportExportRequest +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 = report_export_api.ReportExportApi(api_client) + workspace_id = "workspaceId_example" # str | + report_export_request = ReportExportRequest( + document_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + report_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + timezone_id="Asia/Kolkata", + ) # ReportExportRequest | + x_gdc_debug = 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: + # (EXPERIMENTAL) Create document export request + api_response = api_instance.create_document_export(workspace_id, report_export_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->create_document_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create document export request + api_response = api_instance.create_document_export(workspace_id, report_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->create_document_export: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **report_export_request** | [**ReportExportRequest**](ReportExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**ExportResponse**](ExportResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Document export request created successfully. | - | + +[[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_report_export** > ExportResponse create_report_export(workspace_id, report_export_request) (EXPERIMENTAL) Create report export request -Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. +Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. ### Example @@ -39,6 +130,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = report_export_api.ReportExportApi(api_client) workspace_id = "workspaceId_example" # str | report_export_request = ReportExportRequest( + document_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", file_name="filename", format="PDF", metadata=JsonNode(), @@ -96,12 +188,149 @@ 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_document_export** +> file_type get_document_export(workspace_id, export_id) + +(EXPERIMENTAL) Retrieve exported document + +Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_export_api +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner +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 = report_export_api.ReportExportApi(api_client) + workspace_id = "workspaceId_example" # str | + export_id = "exportId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Retrieve exported document + api_response = api_instance.get_document_export(workspace_id, export_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->get_document_export: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **export_id** | **str**| | + +### Return type + +**file_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Binary export result. | * Content-Disposition -
| +**202** | Request is accepted, provided exportId exists, but export is not yet ready. | - | + +[[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_document_export_metadata** +> get_document_export_metadata(workspace_id, export_id) + +(EXPERIMENTAL) Retrieve document export metadata + +Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_export_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 = report_export_api.ReportExportApi(api_client) + workspace_id = "workspaceId_example" # str | + export_id = "exportId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Retrieve document export metadata + api_instance.get_document_export_metadata(workspace_id, export_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->get_document_export_metadata: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **export_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Json metadata representation | - | + +[[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_report_export** > file_type get_report_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files -Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. +Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. ### Example @@ -110,7 +339,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import report_export_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. @@ -171,7 +400,7 @@ No authorization required (EXPERIMENTAL) Retrieve metadata context -Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. +Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. ### Example diff --git a/gooddata-api-client/docs/ReportExportRequest.md b/gooddata-api-client/docs/ReportExportRequest.md index cc3fe7cc3..ffbccfad9 100644 --- a/gooddata-api-client/docs/ReportExportRequest.md +++ b/gooddata-api-client/docs/ReportExportRequest.md @@ -1,14 +1,15 @@ # ReportExportRequest -Export request object describing the export properties and metadata for report exports. +Export request object describing the export properties and metadata for document exports. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file_name** | **str** | File name to be used for retrieving the pdf document. | -**report_id** | **str** | Report identifier | **format** | **str** | Requested resulting file type. | defaults to "PDF" +**document_id** | **str** | Document identifier; the export renders the Publisher document page. | [optional] **metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**report_id** | **str** | Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'. | [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] diff --git a/gooddata-api-client/docs/SlidesExportApi.md b/gooddata-api-client/docs/SlidesExportApi.md index 73c2ba0d7..9dada3074 100644 --- a/gooddata-api-client/docs/SlidesExportApi.md +++ b/gooddata-api-client/docs/SlidesExportApi.md @@ -117,7 +117,7 @@ Note: This API is an experimental and is going to change. Please, use it accordi import time import gooddata_api_client from gooddata_api_client.api import slides_export_api -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner 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. diff --git a/gooddata-api-client/docs/WorkspaceLocalizationUsage.md b/gooddata-api-client/docs/WorkspaceLocalizationUsage.md new file mode 100644 index 000000000..70002745b --- /dev/null +++ b/gooddata-api-client/docs/WorkspaceLocalizationUsage.md @@ -0,0 +1,13 @@ +# WorkspaceLocalizationUsage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**settings** | [**LocalizationResolvedValues**](LocalizationResolvedValues.md) | | +**values** | [**[LocalizationUsageValue]**](LocalizationUsageValue.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/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index 7d320ef8e..c00b27fe9 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -302,6 +302,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -393,10 +706,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -498,6 +865,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), @@ -1427,6 +1797,319 @@ with gooddata_api_client.ApiClient() as api_client: title="3D map renderer", ), ], + document_templates=[ + DeclarativePublisherDocumentTemplate( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="brand-review", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], + documents=[ + DeclarativePublisherDocument( + content=PublisherDocumentContent( + attribute_filter_configs=[ + PublisherDocumentAttributeFilterConfig( + display_as_label=PublisherDocumentObjRef( + identifier="identifier_example", + type="type_example", + ), + local_identifier="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + mode="readonly", + selection_type="list", + ), + ], + defaults=PublisherDocumentDefaults( + page_size="widescreen", + period=PublisherDocumentPeriod(), + takeaway=PublisherDocumentTakeawayDefaults( + generation=PublisherDocumentTakeawayGeneration( + context=PublisherDocumentTakeawayContext( + filters=True, + other_pages=True, + page_title=True, + widgets=[ + "26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + ], + ), + instructions="instructions_example", + ), + ), + ), + filters=[ + PublisherDocumentFilter(), + ], + format_locale="format_locale_example", + locale="locale_example", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + sections=[ + PublisherDocumentSection( + description="description_example", + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + pages=[ + PublisherDocumentPage( + filters=[ + PublisherDocumentFilter(), + ], + id="26bUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1", + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + visible=True, + ), + ], + title="title_example", + ), + ], + style=PublisherDocumentAreaStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + gap=PublisherDocumentAreaStyleGap(None), + ), + ), + description="description_example", + id="levis-h1-2026", + period=PublisherDocumentPeriod(), + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], export_definitions=[ DeclarativeExportDefinition( created_at="2023-07-20 12:30", @@ -1518,10 +2201,64 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeMetricPermissionsInner(None), + ], tags=["Revenues"], title="Total sales", ), ], + page_templates=[ + DeclarativePublisherDocumentPageTemplate( + content=PublisherDocumentPageTemplateContent( + filters=[ + PublisherDocumentFilter(), + ], + kind="cover", + layout=PublisherDocumentLayoutNode(), + notes="notes_example", + page_size="widescreen", + style=PublisherDocumentPageStyle( + background_color="background_color_example", + background_fit="cover", + background_horizontal_align="left", + background_image="background_image_example", + background_image_opacity=0, + background_offset=0, + background_offset_bottom=0, + background_offset_left=0, + background_offset_right=0, + background_offset_top=0, + background_opacity=0, + background_vertical_align="top", + font_size=0, + font_style="normal", + font_weight=1, + gap=PublisherDocumentAreaStyleGap(None), + horizontal_align="left", + letter_spacing=3.14, + line_height=3.14, + padding=PublisherDocumentContainerStylePadding(None), + padding_bottom=PublisherDocumentContainerStylePadding(None), + padding_left=PublisherDocumentContainerStylePadding(None), + padding_right=PublisherDocumentContainerStylePadding(None), + padding_top=PublisherDocumentContainerStylePadding(None), + text_color="text_color_example", + text_overflow="shrink", + text_style="title", + text_transform="none", + vertical_align="top", + ), + ), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + version="2", + ), + ], parameters=[ DeclarativeParameter( content=ParameterDefinition(), @@ -1623,6 +2360,9 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + permissions=[ + DeclarativeVisualizationObjectPermissionsInner(None), + ], tags=["Revenues"], title="Count of goods", ), 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 d363bf7e3..88cff9c27 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -33,6 +33,8 @@ from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags from gooddata_api_client.model.analyze_csv_request import AnalyzeCsvRequest from gooddata_api_client.model.analyze_csv_response import AnalyzeCsvResponse +from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest +from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest from gooddata_api_client.model.anomaly_detection_result import AnomalyDetectionResult from gooddata_api_client.model.api_entitlement import ApiEntitlement @@ -76,7 +78,7 @@ from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest from gooddata_api_client.model.generate_title_request import GenerateTitleRequest from gooddata_api_client.model.generate_title_response import GenerateTitleResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification from gooddata_api_client.model.identifier_duplications import IdentifierDuplications @@ -85,6 +87,8 @@ from gooddata_api_client.model.import_csv_response import ImportCsvResponse from gooddata_api_client.model.import_geo_collection_request import ImportGeoCollectionRequest from gooddata_api_client.model.import_geo_collection_response import ImportGeoCollectionResponse +from gooddata_api_client.model.import_sav_request import ImportSavRequest +from gooddata_api_client.model.import_sav_response import ImportSavResponse from gooddata_api_client.model.invitation import Invitation from gooddata_api_client.model.ip_allowlist_policy_targets import IpAllowlistPolicyTargets from gooddata_api_client.model.key_drivers_request import KeyDriversRequest @@ -94,6 +98,10 @@ from gooddata_api_client.model.list_llm_provider_models_request import ListLlmProviderModelsRequest from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.locale_request import LocaleRequest +from gooddata_api_client.model.localization_statistics import LocalizationStatistics +from gooddata_api_client.model.localization_usage import LocalizationUsage +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner from gooddata_api_client.model.manage_computed_attribute_permissions_request_inner import ManageComputedAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner @@ -146,6 +154,7 @@ from gooddata_api_client.model.visualization_object_execution import VisualizationObjectExecution from gooddata_api_client.model.visualization_permissions import VisualizationPermissions from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest +from gooddata_api_client.model.workspace_localization_usage import WorkspaceLocalizationUsage from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups from gooddata_api_client.model.workspace_users import WorkspaceUsers @@ -525,6 +534,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.analyze_sav_endpoint = _Endpoint( + settings={ + 'response_type': ([AnalyzeSavResponse],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/fileStorage/staging/analyzeSav', + 'operation_id': 'analyze_sav', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'analyze_sav_request', + ], + 'required': [ + 'analyze_sav_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'analyze_sav_request': + (AnalyzeSavRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'analyze_sav_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.anomaly_detection_endpoint = _Endpoint( settings={ 'response_type': (SmartFunctionResponse,), @@ -1915,6 +1974,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_document_export_endpoint = _Endpoint( + settings={ + 'response_type': (ExportResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document', + 'operation_id': 'create_document_export', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'report_export_request', + 'x_gdc_debug', + ], + 'required': [ + 'workspace_id', + 'report_export_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'report_export_request': + (ReportExportRequest,), + 'x_gdc_debug': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', + }, + 'location_map': { + 'workspace_id': 'path', + 'report_export_request': 'body', + 'x_gdc_debug': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.create_image_export_endpoint = _Endpoint( settings={ 'response_type': (ExportResponse,), @@ -3277,6 +3397,116 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_document_export_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}', + 'operation_id': 'get_document_export', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'export_id', + ], + 'required': [ + 'workspace_id', + 'export_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'export_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'export_id': 'exportId', + }, + 'location_map': { + 'workspace_id': 'path', + 'export_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/pdf' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_document_export_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata', + 'operation_id': 'get_document_export_metadata', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'export_id', + ], + 'required': [ + 'workspace_id', + 'export_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'export_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'export_id': 'exportId', + }, + 'location_map': { + 'workspace_id': 'path', + 'export_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_exported_file_endpoint = _Endpoint( settings={ 'response_type': (file_type,), @@ -4201,6 +4431,62 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.import_sav_endpoint = _Endpoint( + settings={ + 'response_type': ([ImportSavResponse],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav', + 'operation_id': 'import_sav', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data_source_id', + 'import_sav_request', + ], + 'required': [ + 'data_source_id', + 'import_sav_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data_source_id': + (str,), + 'import_sav_request': + (ImportSavRequest,), + }, + 'attribute_map': { + 'data_source_id': 'dataSourceId', + }, + 'location_map': { + 'data_source_id': 'path', + 'import_sav_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.inherited_entity_conflicts_endpoint = _Endpoint( settings={ 'response_type': ([IdentifierDuplications],), @@ -5605,13 +5891,275 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.outlier_detection_endpoint = _Endpoint( + self.organization_localization_statistics_endpoint = _Endpoint( settings={ - 'response_type': (OutlierDetectionResponse,), + 'response_type': (LocalizationStatistics,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers', - 'operation_id': 'outlier_detection', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/organization/localization/statistics', + 'operation_id': 'organization_localization_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsage,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage', + 'operation_id': 'organization_localization_usage', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_users_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageUsers,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage/users', + 'operation_id': 'organization_localization_usage_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageWorkspaces,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage/workspaces', + 'operation_id': 'organization_localization_usage_workspaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.outlier_detection_endpoint = _Endpoint( + settings={ + 'response_type': (OutlierDetectionResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers', + 'operation_id': 'outlier_detection', + 'http_method': 'POST', 'servers': None, }, params_map={ @@ -8490,19 +9038,18 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.workspace_resolve_all_settings_endpoint = _Endpoint( + self.workspace_localization_statistics_endpoint = _Endpoint( settings={ - 'response_type': ([ResolvedSetting],), + 'response_type': (LocalizationStatistics,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_all_settings', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/statistics', + 'operation_id': 'workspace_localization_statistics', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'exclude_user_settings', ], 'required': [ 'workspace_id', @@ -8522,16 +9069,12 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'exclude_user_settings': - (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'exclude_user_settings': 'excludeUserSettings', }, 'location_map': { 'workspace_id': 'path', - 'exclude_user_settings': 'query', }, 'collection_format_map': { } @@ -8544,24 +9087,21 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.workspace_resolve_settings_endpoint = _Endpoint( + self.workspace_localization_usage_endpoint = _Endpoint( settings={ - 'response_type': ([ResolvedSetting],), + 'response_type': (WorkspaceLocalizationUsage,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', - 'operation_id': 'workspace_resolve_settings', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage', + 'operation_id': 'workspace_localization_usage', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'resolve_settings_request', - 'exclude_user_settings', ], 'required': [ 'workspace_id', - 'resolve_settings_request', ], 'nullable': [ ], @@ -8578,19 +9118,12 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'resolve_settings_request': - (ResolveSettingsRequest,), - 'exclude_user_settings': - (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'exclude_user_settings': 'excludeUserSettings', }, 'location_map': { 'workspace_id': 'path', - 'resolve_settings_request': 'body', - 'exclude_user_settings': 'query', }, 'collection_format_map': { } @@ -8599,16 +9132,225 @@ def __init__(self, api_client=None): 'accept': [ 'application/json' ], - 'content_type': [ - 'application/json' - ] + 'content_type': [], }, api_client=api_client ) + self.workspace_localization_usage_users_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageUsers,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/users', + 'operation_id': 'workspace_localization_usage_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { - def add_targets( - self, - id, + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'workspace_id': 'path', + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_resolve_all_settings_endpoint = _Endpoint( + settings={ + 'response_type': ([ResolvedSetting],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + 'operation_id': 'workspace_resolve_all_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'exclude_user_settings', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'exclude_user_settings': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'exclude_user_settings': 'excludeUserSettings', + }, + 'location_map': { + 'workspace_id': 'path', + 'exclude_user_settings': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_resolve_settings_endpoint = _Endpoint( + settings={ + 'response_type': ([ResolvedSetting],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/resolveSettings', + 'operation_id': 'workspace_resolve_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'resolve_settings_request', + 'exclude_user_settings', + ], + 'required': [ + 'workspace_id', + 'resolve_settings_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'resolve_settings_request': + (ResolveSettingsRequest,), + 'exclude_user_settings': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'exclude_user_settings': 'excludeUserSettings', + }, + 'location_map': { + 'workspace_id': 'path', + 'resolve_settings_request': 'body', + 'exclude_user_settings': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def add_targets( + self, + id, ip_allowlist_policy_targets, **kwargs ): @@ -9185,6 +9927,89 @@ def analyze_csv( analyze_csv_request return self.analyze_csv_endpoint.call_with_http_info(**kwargs) + def analyze_sav( + self, + analyze_sav_request, + **kwargs + ): + """Analyze SPSS files # noqa: E501 + + Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.analyze_sav(analyze_sav_request, async_req=True) + >>> result = thread.get() + + Args: + analyze_sav_request (AnalyzeSavRequest): + + 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: + [AnalyzeSavResponse] + 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['analyze_sav_request'] = \ + analyze_sav_request + return self.analyze_sav_endpoint.call_with_http_info(**kwargs) + def anomaly_detection( self, workspace_id, @@ -11108,24 +11933,24 @@ def create_dashboard_export_request( dashboard_tabular_export_request return self.create_dashboard_export_request_endpoint.call_with_http_info(**kwargs) - def create_image_export( + def create_document_export( self, workspace_id, - image_export_request, + report_export_request, **kwargs ): - """(EXPERIMENTAL) Create image export request # noqa: E501 + """(EXPERIMENTAL) Create document export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) + >>> thread = api.create_document_export(workspace_id, report_export_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - image_export_request (ImageExportRequest): + report_export_request (ReportExportRequest): Keyword Args: x_gdc_debug (bool): [optional] if omitted the server will use the default value of False @@ -11192,28 +12017,116 @@ def create_image_export( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['image_export_request'] = \ - image_export_request - return self.create_image_export_endpoint.call_with_http_info(**kwargs) + kwargs['report_export_request'] = \ + report_export_request + return self.create_document_export_endpoint.call_with_http_info(**kwargs) - def create_pdf_export( + def create_image_export( self, workspace_id, - visual_export_request, + image_export_request, **kwargs ): - """Create visual - pdf export request # noqa: E501 + """(EXPERIMENTAL) Create image export request # noqa: E501 - An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_pdf_export(workspace_id, visual_export_request, async_req=True) + >>> thread = api.create_image_export(workspace_id, image_export_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - visual_export_request (VisualExportRequest): + image_export_request (ImageExportRequest): + + Keyword Args: + x_gdc_debug (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: + ExportResponse + 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['image_export_request'] = \ + image_export_request + return self.create_image_export_endpoint.call_with_http_info(**kwargs) + + def create_pdf_export( + self, + workspace_id, + visual_export_request, + **kwargs + ): + """Create visual - pdf export request # noqa: E501 + + An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_pdf_export(workspace_id, visual_export_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + visual_export_request (VisualExportRequest): Keyword Args: x_gdc_debug (bool): [optional] if omitted the server will use the default value of False @@ -11379,7 +12292,7 @@ def create_report_export( ): """(EXPERIMENTAL) Create report export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -13097,6 +14010,180 @@ def get_dependent_entities_graph_from_entry_points( dependent_entities_request return self.get_dependent_entities_graph_from_entry_points_endpoint.call_with_http_info(**kwargs) + def get_document_export( + self, + workspace_id, + export_id, + **kwargs + ): + """(EXPERIMENTAL) Retrieve exported document # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_document_export(workspace_id, export_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + export_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: + file_type + 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['export_id'] = \ + export_id + return self.get_document_export_endpoint.call_with_http_info(**kwargs) + + def get_document_export_metadata( + self, + workspace_id, + export_id, + **kwargs + ): + """(EXPERIMENTAL) Retrieve document export metadata # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified. # 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_document_export_metadata(workspace_id, export_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + export_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['export_id'] = \ + export_id + return self.get_document_export_metadata_endpoint.call_with_http_info(**kwargs) + def get_exported_file( self, workspace_id, @@ -13793,7 +14880,7 @@ def get_report_export( ): """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -13880,7 +14967,7 @@ def get_report_export_metadata( ): """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. # noqa: E501 + Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14311,7 +15398,7 @@ def import_csv( ): """Import CSV # noqa: E501 - Import the CSV files at the given locations in the staging area to the final location. # noqa: E501 + Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14477,9 +15564,96 @@ def import_custom_geo_collection( import_geo_collection_request return self.import_custom_geo_collection_endpoint.call_with_http_info(**kwargs) - def inherited_entity_conflicts( + def import_sav( self, - workspace_id, + data_source_id, + import_sav_request, + **kwargs + ): + """Import SPSS files # noqa: E501 + + Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_sav(data_source_id, import_sav_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): + import_sav_request (ImportSavRequest): + + 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: + [ImportSavResponse] + 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['data_source_id'] = \ + data_source_id + kwargs['import_sav_request'] = \ + import_sav_request + return self.import_sav_endpoint.call_with_http_info(**kwargs) + + def inherited_entity_conflicts( + self, + workspace_id, **kwargs ): """Finds identifier conflicts in workspace hierarchy. # noqa: E501 @@ -16507,7 +17681,335 @@ def memory_created_by_users( async_req (bool): execute request asynchronously Returns: - MemoryItemCreatedByUsers + MemoryItemCreatedByUsers + 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.memory_created_by_users_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 organization_localization_statistics( + self, + **kwargs + ): + """(BETA) Languages with translations in the organization. # noqa: E501 + + (BETA) Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_statistics(async_req=True) + >>> 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: + LocalizationStatistics + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_statistics_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage( + self, + **kwargs + ): + """(BETA) Languages used in the organization. # noqa: E501 + + (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationUsage + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_usage_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage_users( + self, + **kwargs + ): + """(BETA) Users who set a language themselves. # noqa: E501 + + (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage_users(async_req=True) + >>> result = thread.get() + + + Keyword Args: + value (str): Language tag that the user sets.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + 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: + LocalizationUsageUsers If the method is called asynchronously, returns the request thread. """ @@ -16536,29 +18038,29 @@ 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.organization_localization_usage_users_endpoint.call_with_http_info(**kwargs) - def metric_permissions( + def organization_localization_usage_workspaces( self, - workspace_id, - metric_id, **kwargs ): - """(BETA) Get Metric Permissions # noqa: E501 + """(BETA) Workspaces that use a language. # noqa: E501 + (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. # 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) + >>> thread = api.organization_localization_usage_workspaces(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - metric_id (str): Keyword Args: + value (str): Language tag that the workspace gets.. [optional] + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -16591,7 +18093,7 @@ def metric_permissions( async_req (bool): execute request asynchronously Returns: - MetricPermissions + LocalizationUsageWorkspaces If the method is called asynchronously, returns the request thread. """ @@ -16620,11 +18122,7 @@ def metric_permissions( '_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) + return self.organization_localization_usage_workspaces_endpoint.call_with_http_info(**kwargs) def outlier_detection( self, @@ -21100,6 +22598,261 @@ def visualization_permissions( visualization_object_id return self.visualization_permissions_endpoint.call_with_http_info(**kwargs) + def workspace_localization_statistics( + self, + workspace_id, + **kwargs + ): + """(BETA) Languages with translations in the workspace. # noqa: E501 + + (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_statistics(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationStatistics + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_statistics_endpoint.call_with_http_info(**kwargs) + + def workspace_localization_usage( + self, + workspace_id, + **kwargs + ): + """(BETA) Languages used in the workspace. # noqa: E501 + + (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + WorkspaceLocalizationUsage + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_usage_endpoint.call_with_http_info(**kwargs) + + def workspace_localization_usage_users( + self, + workspace_id, + **kwargs + ): + """(BETA) Workspace members who get a language. # noqa: E501 + + (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage_users(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + value (str): Language tag that the user gets.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationUsageUsers + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_usage_users_endpoint.call_with_http_info(**kwargs) + def workspace_resolve_all_settings( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/data_source_files_analysis_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_files_analysis_api.py index e4a2affde..ca58dfe53 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_source_files_analysis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_files_analysis_api.py @@ -24,6 +24,8 @@ ) from gooddata_api_client.model.analyze_csv_request import AnalyzeCsvRequest from gooddata_api_client.model.analyze_csv_response import AnalyzeCsvResponse +from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest +from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse class DataSourceFilesAnalysisApi(object): @@ -87,6 +89,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.analyze_sav_endpoint = _Endpoint( + settings={ + 'response_type': ([AnalyzeSavResponse],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/fileStorage/staging/analyzeSav', + 'operation_id': 'analyze_sav', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'analyze_sav_request', + ], + 'required': [ + 'analyze_sav_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'analyze_sav_request': + (AnalyzeSavRequest,), + }, + 'attribute_map': { + }, + 'location_map': { + 'analyze_sav_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def analyze_csv( self, @@ -171,3 +223,86 @@ def analyze_csv( analyze_csv_request return self.analyze_csv_endpoint.call_with_http_info(**kwargs) + def analyze_sav( + self, + analyze_sav_request, + **kwargs + ): + """Analyze SPSS files # noqa: E501 + + Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.analyze_sav(analyze_sav_request, async_req=True) + >>> result = thread.get() + + Args: + analyze_sav_request (AnalyzeSavRequest): + + 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: + [AnalyzeSavResponse] + 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['analyze_sav_request'] = \ + analyze_sav_request + return self.analyze_sav_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/data_source_files_import_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_files_import_api.py index 46395edf0..2a4ac424d 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_source_files_import_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_files_import_api.py @@ -24,6 +24,8 @@ ) from gooddata_api_client.model.import_csv_request import ImportCsvRequest from gooddata_api_client.model.import_csv_response import ImportCsvResponse +from gooddata_api_client.model.import_sav_request import ImportSavRequest +from gooddata_api_client.model.import_sav_response import ImportSavResponse class DataSourceFilesImportApi(object): @@ -93,6 +95,62 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.import_sav_endpoint = _Endpoint( + settings={ + 'response_type': ([ImportSavResponse],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav', + 'operation_id': 'import_sav', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data_source_id', + 'import_sav_request', + ], + 'required': [ + 'data_source_id', + 'import_sav_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data_source_id': + (str,), + 'import_sav_request': + (ImportSavRequest,), + }, + 'attribute_map': { + 'data_source_id': 'dataSourceId', + }, + 'location_map': { + 'data_source_id': 'path', + 'import_sav_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def import_csv( self, @@ -102,7 +160,7 @@ def import_csv( ): """Import CSV # noqa: E501 - Import the CSV files at the given locations in the staging area to the final location. # noqa: E501 + Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -181,3 +239,90 @@ def import_csv( import_csv_request return self.import_csv_endpoint.call_with_http_info(**kwargs) + def import_sav( + self, + data_source_id, + import_sav_request, + **kwargs + ): + """Import SPSS files # noqa: E501 + + Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.import_sav(data_source_id, import_sav_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): + import_sav_request (ImportSavRequest): + + 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: + [ImportSavResponse] + 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['data_source_id'] = \ + data_source_id + kwargs['import_sav_request'] = \ + import_sav_request + return self.import_sav_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/document_controller_api.py b/gooddata-api-client/gooddata_api_client/api/document_controller_api.py new file mode 100644 index 000000000..02381030a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/document_controller_api.py @@ -0,0 +1,1106 @@ +""" + 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_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument + + +class DocumentControllerApi(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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'create_entity_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_post_optional_id_document': + (JsonApiPublisherDocumentPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'delete_entity_documents', + '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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'get_all_entities_documents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'get_entity_documents', + '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.patch_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'patch_entity_documents', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_patch_document': + (JsonApiPublisherDocumentPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'update_entity_documents', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_in_document': + (JsonApiPublisherDocumentInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_documents( + self, + workspace_id, + json_api_publisher_document_post_optional_id_document, + **kwargs + ): + """Post Document # 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_documents(workspace_id, json_api_publisher_document_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_post_optional_id_document (JsonApiPublisherDocumentPostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_post_optional_id_document'] = \ + json_api_publisher_document_post_optional_id_document + return self.create_entity_documents_endpoint.call_with_http_info(**kwargs) + + def delete_entity_documents( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Document # 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_documents(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_documents_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_documents( + self, + workspace_id, + **kwargs + ): + """Get all Documents # 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_documents(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 + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiPublisherDocumentOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_documents_endpoint.call_with_http_info(**kwargs) + + def get_entity_documents( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document # 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_documents(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: + JsonApiPublisherDocumentOutDocument + 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_documents_endpoint.call_with_http_info(**kwargs) + + def patch_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_patch_document, + **kwargs + ): + """Patch a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_patch_document (JsonApiPublisherDocumentPatchDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_patch_document'] = \ + json_api_publisher_document_patch_document + return self.patch_entity_documents_endpoint.call_with_http_info(**kwargs) + + def update_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_in_document, + **kwargs + ): + """Put a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_in_document (JsonApiPublisherDocumentInDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_in_document'] = \ + json_api_publisher_document_in_document + return self.update_entity_documents_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/document_template_controller_api.py b/gooddata-api-client/gooddata_api_client/api/document_template_controller_api.py new file mode 100644 index 000000000..dcedde89b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/document_template_controller_api.py @@ -0,0 +1,1106 @@ +""" + 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_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument + + +class DocumentTemplateControllerApi(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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'create_entity_document_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_template_post_optional_id_document': + (JsonApiPublisherDocumentTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'delete_entity_document_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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'get_all_entities_document_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'get_entity_document_templates', + '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.patch_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'patch_entity_document_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_patch_document': + (JsonApiPublisherDocumentTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'update_entity_document_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_in_document': + (JsonApiPublisherDocumentTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_document_templates( + self, + workspace_id, + json_api_publisher_document_template_post_optional_id_document, + **kwargs + ): + """Post Document 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_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_template_post_optional_id_document (JsonApiPublisherDocumentTemplatePostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_post_optional_id_document'] = \ + json_api_publisher_document_template_post_optional_id_document + return self.create_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_document_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Document 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_document_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_document_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_document_templates( + self, + workspace_id, + **kwargs + ): + """Get all Document 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_document_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] + 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 + 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: + JsonApiPublisherDocumentTemplateOutList + 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_document_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_document_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document 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_document_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] + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_document_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_patch_document, + **kwargs + ): + """Patch a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_patch_document (JsonApiPublisherDocumentTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_patch_document'] = \ + json_api_publisher_document_template_patch_document + return self.patch_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_in_document, + **kwargs + ): + """Put a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_in_document (JsonApiPublisherDocumentTemplateInDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_in_document'] = \ + json_api_publisher_document_template_in_document + return self.update_entity_document_templates_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 b60fa584e..8b35abb90 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -174,6 +174,21 @@ from gooddata_api_client.model.json_api_parameter_out_list import JsonApiParameterOutList from gooddata_api_client.model.json_api_parameter_patch_document import JsonApiParameterPatchDocument from gooddata_api_client.model.json_api_parameter_post_optional_id_document import JsonApiParameterPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_report_in_document import JsonApiReportInDocument from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument from gooddata_api_client.model.json_api_report_out_list import JsonApiReportOutList @@ -1264,6 +1279,184 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'create_entity_document_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_template_post_optional_id_document': + (JsonApiPublisherDocumentTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'create_entity_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_post_optional_id_document': + (JsonApiPublisherDocumentPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) self.create_entity_export_definitions_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportDefinitionOutDocument,), @@ -2244,25 +2437,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_parameters_endpoint = _Endpoint( + self.create_entity_page_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiParameterOutDocument,), + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters', - 'operation_id': 'create_entity_parameters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'create_entity_page_templates', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_parameter_post_optional_id_document', + 'json_api_publisher_document_page_template_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_parameter_post_optional_id_document', + 'json_api_publisher_document_page_template_post_optional_id_document', ], 'nullable': [ ], @@ -2298,8 +2491,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_parameter_post_optional_id_document': - (JsonApiParameterPostOptionalIdDocument,), + 'json_api_publisher_document_page_template_post_optional_id_document': + (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -2312,96 +2505,185 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_parameter_post_optional_id_document': 'body', - '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': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_report_page_layouts_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiReportPageLayoutOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts', - 'operation_id': 'create_entity_report_page_layouts', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'json_api_report_page_layout_post_optional_id_document', - 'include', - 'meta_include', - ], - 'required': [ - 'workspace_id', - 'json_api_report_page_layout_post_optional_id_document', - ], - '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,), - 'json_api_report_page_layout_post_optional_id_document': - (JsonApiReportPageLayoutPostOptionalIdDocument,), - 'include': - ([str],), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'include': 'include', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'workspace_id': 'path', - 'json_api_report_page_layout_post_optional_id_document': 'body', + 'json_api_publisher_document_page_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_parameters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiParameterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters', + 'operation_id': 'create_entity_parameters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_parameter_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_parameter_post_optional_id_document', + ], + '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,), + 'json_api_parameter_post_optional_id_document': + (JsonApiParameterPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_parameter_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts', + 'operation_id': 'create_entity_report_page_layouts', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_report_page_layout_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_report_page_layout_post_optional_id_document', + ], + '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,), + 'json_api_report_page_layout_post_optional_id_document': + (JsonApiReportPageLayoutPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_report_page_layout_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -4350,12 +4632,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_export_definitions_endpoint = _Endpoint( + self.delete_entity_document_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'delete_entity_export_definitions', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'delete_entity_document_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -4403,50 +4685,49 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_export_templates_endpoint = _Endpoint( + self.delete_entity_documents_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'delete_entity_export_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'delete_entity_documents', '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': { } @@ -4457,12 +4738,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_filter_contexts_endpoint = _Endpoint( + self.delete_entity_export_definitions_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'delete_entity_filter_contexts', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'delete_entity_export_definitions', 'http_method': 'DELETE', 'servers': None, }, @@ -4510,12 +4791,119 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_filter_views_endpoint = _Endpoint( + self.delete_entity_export_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'delete_entity_filter_views', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'delete_entity_export_templates', + '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_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'delete_entity_filter_contexts', + '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_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'delete_entity_filter_views', 'http_method': 'DELETE', 'servers': None, }, @@ -5100,12 +5488,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_parameters_endpoint = _Endpoint( + self.delete_entity_page_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}', - 'operation_id': 'delete_entity_parameters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'delete_entity_page_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -5153,12 +5541,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_report_page_layouts_endpoint = _Endpoint( + self.delete_entity_parameters_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', - 'operation_id': 'delete_entity_report_page_layouts', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}', + 'operation_id': 'delete_entity_parameters', 'http_method': 'DELETE', 'servers': None, }, @@ -5206,12 +5594,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_report_templates_endpoint = _Endpoint( + self.delete_entity_report_page_layouts_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', - 'operation_id': 'delete_entity_report_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'delete_entity_report_page_layouts', 'http_method': 'DELETE', 'servers': None, }, @@ -5259,12 +5647,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_reports_endpoint = _Endpoint( + self.delete_entity_report_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', - 'operation_id': 'delete_entity_reports', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'delete_entity_report_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -5312,66 +5700,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', - '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_user_data_filters_endpoint = _Endpoint( + self.delete_entity_reports_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'delete_entity_user_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'delete_entity_reports', 'http_method': 'DELETE', 'servers': None, }, @@ -5419,126 +5753,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_groups_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', - '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_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'id': - (str,), - }, - 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', - }, - 'location_map': { - 'user_id': 'path', - 'id': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) - self.delete_entity_users_endpoint = _Endpoint( + self.delete_entity_themes_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'delete_entity_themes', 'http_method': 'DELETE', 'servers': None, }, @@ -5587,12 +5807,233 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( + self.delete_entity_user_data_filters_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'delete_entity_visualization_objects', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'delete_entity_user_data_filters', + '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_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'delete_entity_user_groups', + '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_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'delete_entity_user_settings', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + ], + 'required': [ + 'user_id', + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'id': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_entity_users_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'delete_entity_users', + '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_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'delete_entity_visualization_objects', 'http_method': 'DELETE', 'servers': None, }, @@ -7947,27 +8388,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_entitlements_endpoint = _Endpoint( + self.get_all_entities_document_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiEntitlementOutList,), + 'response_type': (JsonApiPublisherDocumentTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/entitlements', - 'operation_id': 'get_all_entities_entitlements', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'get_all_entities_document_templates', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -7981,40 +8430,71 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -8028,12 +8508,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_export_definitions_endpoint = _Endpoint( + self.get_all_entities_documents_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportDefinitionOutList,), + 'response_type': (JsonApiPublisherDocumentOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', - 'operation_id': 'get_all_entities_export_definitions', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'get_all_entities_documents', 'http_method': 'GET', 'servers': None, }, @@ -8078,13 +8558,7 @@ def __init__(self, api_client=None): }, ('include',): { - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "ALL": "ALL" @@ -8154,12 +8628,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_export_templates_endpoint = _Endpoint( + self.get_all_entities_entitlements_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutList,), + 'response_type': (JsonApiEntitlementOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates', - 'operation_id': 'get_all_entities_export_templates', + 'endpoint_path': '/api/v1/entities/entitlements', + 'operation_id': 'get_all_entities_entitlements', 'http_method': 'GET', 'servers': None, }, @@ -8235,12 +8709,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_facts_endpoint = _Endpoint( + self.get_all_entities_export_definitions_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFactOutList,), + 'response_type': (JsonApiExportDefinitionOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', - 'operation_id': 'get_all_entities_facts', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions', + 'operation_id': 'get_all_entities_export_definitions', 'http_method': 'GET', 'servers': None, }, @@ -8285,13 +8759,19 @@ def __init__(self, api_client=None): }, ('include',): { - "DATASETS": "datasets", - "DATASET": "dataset", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { - "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -8355,12 +8835,93 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_filter_contexts_endpoint = _Endpoint( + self.get_all_entities_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterContextOutList,), + 'response_type': (JsonApiExportTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', - 'operation_id': 'get_all_entities_filter_contexts', + 'endpoint_path': '/api/v1/entities/exportTemplates', + 'operation_id': 'get_all_entities_export_templates', + '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_facts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFactOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/facts', + 'operation_id': 'get_all_entities_facts', 'http_method': 'GET', 'servers': None, }, @@ -8405,16 +8966,13 @@ def __init__(self, api_client=None): }, ('include',): { - "ATTRIBUTES": "attributes", "DATASETS": "datasets", - "LABELS": "labels", - "COMPUTEDATTRIBUTES": "computedAttributes", - "METRICS": "metrics", - "FACTS": "facts", + "DATASET": "dataset", "ALL": "ALL" }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -8478,12 +9036,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_filter_views_endpoint = _Endpoint( + self.get_all_entities_filter_contexts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterViewOutList,), + 'response_type': (JsonApiFilterContextOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', - 'operation_id': 'get_all_entities_filter_views', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts', + 'operation_id': 'get_all_entities_filter_contexts', 'http_method': 'GET', 'servers': None, }, @@ -8528,14 +9086,17 @@ def __init__(self, api_client=None): }, ('include',): { - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" @@ -8598,12 +9159,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_fiscal_calendars_endpoint = _Endpoint( + self.get_all_entities_filter_views_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFiscalCalendarOutList,), + 'response_type': (JsonApiFilterViewOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars', - 'operation_id': 'get_all_entities_fiscal_calendars', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews', + 'operation_id': 'get_all_entities_filter_views', 'http_method': 'GET', 'servers': None, }, @@ -8612,6 +9173,7 @@ def __init__(self, api_client=None): 'workspace_id', 'origin', 'filter', + 'include', 'page', 'size', 'sort', @@ -8625,6 +9187,7 @@ def __init__(self, api_client=None): ], 'enum': [ 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -8644,6 +9207,14 @@ def __init__(self, api_client=None): "PARENTS": "PARENTS", "NATIVE": "NATIVE" }, + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, ('meta_include',): { "PAGE": "page", @@ -8658,6 +9229,8 @@ def __init__(self, api_client=None): (str,), 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': @@ -8673,6 +9246,7 @@ def __init__(self, api_client=None): 'workspace_id': 'workspaceId', 'origin': 'origin', 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -8683,6 +9257,7 @@ def __init__(self, api_client=None): 'workspace_id': 'path', 'origin': 'query', 'filter': 'query', + 'include': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', @@ -8690,6 +9265,7 @@ def __init__(self, api_client=None): 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'sort': 'multi', 'meta_include': 'csv', } @@ -8703,27 +9279,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': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', 'meta_include', ], 'validation': [ @@ -8737,6 +9319,12 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, ('meta_include',): { "PAGE": "page", @@ -8745,6 +9333,10 @@ def __init__(self, api_client=None): }, }, 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), 'filter': (str,), 'page': @@ -8753,21 +9345,29 @@ def __init__(self, api_client=None): (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': { @@ -8784,19 +9384,18 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_ip_allowlist_policies_endpoint = _Endpoint( + self.get_all_entities_identity_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIpAllowlistPolicyOutList,), + 'response_type': (JsonApiIdentityProviderOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/ipAllowlistPolicies', - 'operation_id': 'get_all_entities_ip_allowlist_policies', + 'endpoint_path': '/api/v1/entities/identityProviders', + 'operation_id': 'get_all_entities_identity_providers', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'filter', - 'include', 'page', 'size', 'sort', @@ -8806,7 +9405,6 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', 'meta_include', ], 'validation': [ @@ -8820,12 +9418,6 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERS": "users", - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, ('meta_include',): { "PAGE": "page", @@ -8836,8 +9428,6 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), - 'include': - ([str],), 'page': (int,), 'size': @@ -8849,7 +9439,6 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', - 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -8857,14 +9446,12 @@ def __init__(self, api_client=None): }, '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', } @@ -8878,18 +9465,19 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_jwks_endpoint = _Endpoint( + self.get_all_entities_ip_allowlist_policies_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiJwkOutList,), + 'response_type': (JsonApiIpAllowlistPolicyOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/jwks', - 'operation_id': 'get_all_entities_jwks', + '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', @@ -8899,6 +9487,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -8912,6 +9501,12 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, ('meta_include',): { "PAGE": "page", @@ -8922,6 +9517,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), + 'include': + ([str],), 'page': (int,), 'size': @@ -8933,6 +9530,7 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', + 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -8940,12 +9538,14 @@ def __init__(self, api_client=None): }, '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', } @@ -8959,35 +9559,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( + self.get_all_entities_jwks_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), + 'response_type': (JsonApiJwkOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', - 'operation_id': 'get_all_entities_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/jwks', + 'operation_id': 'get_all_entities_jwks', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'origin', 'filter', - 'include', 'page', 'size', 'sort', - 'x_gdc_validate_relations', 'meta_include', ], - 'required': [ - 'workspace_id', - ], + 'required': [], 'nullable': [ ], 'enum': [ - 'origin', - 'include', 'meta_include', ], 'validation': [ @@ -9001,72 +9593,40 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "ALL": "ALL" - }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -9080,12 +9640,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_labels_endpoint = _Endpoint( + self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLabelOutList,), + 'response_type': (JsonApiKnowledgeRecommendationOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', - 'operation_id': 'get_all_entities_labels', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', + 'operation_id': 'get_all_entities_knowledge_recommendations', 'http_method': 'GET', 'servers': None, }, @@ -9130,13 +9690,14 @@ def __init__(self, api_client=None): }, ('include',): { - "ATTRIBUTES": "attributes", - "ATTRIBUTE": "attribute", + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", "ALL": "ALL" }, ('meta_include',): { - "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -9200,27 +9761,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_llm_providers_endpoint = _Endpoint( + self.get_all_entities_labels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiLlmProviderOutList,), + 'response_type': (JsonApiLabelOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/llmProviders', - 'operation_id': 'get_all_entities_llm_providers', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/labels', + 'operation_id': 'get_all_entities_labels', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -9234,40 +9803,71 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "ATTRIBUTES": "attributes", + "ATTRIBUTE": "attribute", + "ALL": "ALL" + }, ('meta_include',): { + "PERMISSIONS": "permissions", + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -9281,35 +9881,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_memory_items_endpoint = _Endpoint( + self.get_all_entities_llm_providers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutList,), + 'response_type': (JsonApiLlmProviderOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', - 'operation_id': 'get_all_entities_memory_items', + 'endpoint_path': '/api/v1/entities/llmProviders', + 'operation_id': 'get_all_entities_llm_providers', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'origin', 'filter', - 'include', 'page', 'size', 'sort', - 'x_gdc_validate_relations', 'meta_include', ], - 'required': [ - 'workspace_id', - ], + 'required': [], 'nullable': [ ], 'enum': [ - 'origin', - 'include', 'meta_include', ], 'validation': [ @@ -9323,71 +9915,40 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -9401,12 +9962,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_metrics_endpoint = _Endpoint( + self.get_all_entities_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMetricOutList,), + 'response_type': (JsonApiMemoryItemOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', - 'operation_id': 'get_all_entities_metrics', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', + 'operation_id': 'get_all_entities_memory_items', 'http_method': 'GET', 'servers': None, }, @@ -9452,21 +10013,12 @@ def __init__(self, api_client=None): ('include',): { "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "COMPUTEDATTRIBUTES": "computedAttributes", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", "ALL": "ALL" }, ('meta_include',): { - "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -9530,27 +10082,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( + self.get_all_entities_metrics_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiNotificationChannelIdentifierOutList,), + 'response_type': (JsonApiMetricOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', - 'operation_id': 'get_all_entities_notification_channel_identifiers', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/metrics', + 'operation_id': 'get_all_entities_metrics', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -9564,121 +10124,80 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('meta_include',): { + ('origin',): { - "PAGE": "page", - "ALL": "all", - "ALL": "ALL" + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" }, - }, - '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_notification_channels_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiNotificationChannelOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/notificationChannels', - 'operation_id': 'get_all_entities_notification_channels', - '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',): { + ('include',): { + "USERIDENTIFIERS": "userIdentifiers", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "DATASETS": "datasets", + "PARAMETERS": "parameters", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "ALL": "ALL" }, - }, - 'allowed_values': { ('meta_include',): { + "PERMISSIONS": "permissions", + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -9692,19 +10211,18 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_org_memory_items_endpoint = _Endpoint( + self.get_all_entities_notification_channel_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutList,), + 'response_type': (JsonApiNotificationChannelIdentifierOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems', - 'operation_id': 'get_all_entities_org_memory_items', + 'endpoint_path': '/api/v1/entities/notificationChannelIdentifiers', + 'operation_id': 'get_all_entities_notification_channel_identifiers', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'filter', - 'include', 'page', 'size', 'sort', @@ -9714,7 +10232,6 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', 'meta_include', ], 'validation': [ @@ -9728,13 +10245,6 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, ('meta_include',): { "PAGE": "page", @@ -9745,8 +10255,6 @@ def __init__(self, api_client=None): 'openapi_types': { 'filter': (str,), - 'include': - ([str],), 'page': (int,), 'size': @@ -9758,7 +10266,6 @@ def __init__(self, api_client=None): }, 'attribute_map': { 'filter': 'filter', - 'include': 'include', 'page': 'page', 'size': 'size', 'sort': 'sort', @@ -9766,14 +10273,12 @@ def __init__(self, api_client=None): }, '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', } @@ -9787,12 +10292,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_organization_settings_endpoint = _Endpoint( + self.get_all_entities_notification_channels_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrganizationSettingOutList,), + 'response_type': (JsonApiNotificationChannelOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/organizationSettings', - 'operation_id': 'get_all_entities_organization_settings', + 'endpoint_path': '/api/v1/entities/notificationChannels', + 'operation_id': 'get_all_entities_notification_channels', 'http_method': 'GET', 'servers': None, }, @@ -9868,34 +10373,28 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_parameters_endpoint = _Endpoint( + self.get_all_entities_org_memory_items_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiParameterOutList,), + 'response_type': (JsonApiOrgMemoryItemOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters', - 'operation_id': 'get_all_entities_parameters', + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'get_all_entities_org_memory_items', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'origin', 'filter', 'include', 'page', 'size', 'sort', - 'x_gdc_validate_relations', 'meta_include', ], - 'required': [ - 'workspace_id', - ], + 'required': [], 'nullable': [ ], 'enum': [ - 'origin', 'include', 'meta_include', ], @@ -9910,12 +10409,6 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, ('include',): { "USERIDENTIFIERS": "userIdentifiers", @@ -9925,17 +10418,12 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), 'filter': (str,), 'include': @@ -9946,31 +10434,23 @@ def __init__(self, api_client=None): (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': { @@ -9988,35 +10468,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_report_page_layouts_endpoint = _Endpoint( + self.get_all_entities_organization_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiReportPageLayoutOutList,), + 'response_type': (JsonApiOrganizationSettingOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts', - 'operation_id': 'get_all_entities_report_page_layouts', + 'endpoint_path': '/api/v1/entities/organizationSettings', + 'operation_id': 'get_all_entities_organization_settings', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'origin', 'filter', - 'include', 'page', 'size', 'sort', - 'x_gdc_validate_relations', 'meta_include', ], - 'required': [ - 'workspace_id', - ], + 'required': [], 'nullable': [ ], 'enum': [ - 'origin', - 'include', 'meta_include', ], 'validation': [ @@ -10030,71 +10502,40 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -10108,12 +10549,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_report_templates_endpoint = _Endpoint( + self.get_all_entities_page_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiReportTemplateOutList,), + 'response_type': (JsonApiPublisherDocumentPageTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', - 'operation_id': 'get_all_entities_report_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'get_all_entities_page_templates', 'http_method': 'GET', 'servers': None, }, @@ -10228,12 +10669,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_reports_endpoint = _Endpoint( + self.get_all_entities_parameters_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiReportOutList,), + 'response_type': (JsonApiParameterOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports', - 'operation_id': 'get_all_entities_reports', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/parameters', + 'operation_id': 'get_all_entities_parameters', 'http_method': 'GET', 'servers': None, }, @@ -10348,27 +10789,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_themes_endpoint = _Endpoint( + self.get_all_entities_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutList,), + 'response_type': (JsonApiReportPageLayoutOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'get_all_entities_themes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts', + 'operation_id': 'get_all_entities_report_page_layouts', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -10382,40 +10831,71 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, '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', } @@ -10429,12 +10909,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_data_filters_endpoint = _Endpoint( + self.get_all_entities_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserDataFilterOutList,), + 'response_type': (JsonApiReportTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'get_all_entities_user_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'get_all_entities_report_templates', 'http_method': 'GET', 'servers': None, }, @@ -10479,17 +10959,9 @@ def __init__(self, api_client=None): }, ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "COMPUTEDATTRIBUTES": "computedAttributes", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", - "USER": "user", - "USERGROUP": "userGroup", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -10557,28 +11029,34 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_groups_endpoint = _Endpoint( + self.get_all_entities_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutList,), + 'response_type': (JsonApiReportOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'get_all_entities_user_groups', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports', + 'operation_id': 'get_all_entities_reports', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'workspace_id', + 'origin', 'filter', 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], - 'required': [], + 'required': [ + 'workspace_id', + ], 'nullable': [ ], 'enum': [ + 'origin', 'include', 'meta_include', ], @@ -10593,20 +11071,32 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, ('include',): { - "USERGROUPS": "userGroups", - "PARENTS": "parents", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), 'filter': (str,), 'include': @@ -10617,23 +11107,31 @@ def __init__(self, api_client=None): (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': { @@ -10651,12 +11149,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_identifiers_endpoint = _Endpoint( + self.get_all_entities_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserIdentifierOutList,), + 'response_type': (JsonApiThemeOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers', - 'operation_id': 'get_all_entities_user_identifiers', + 'endpoint_path': '/api/v1/entities/themes', + 'operation_id': 'get_all_entities_themes', 'http_method': 'GET', 'servers': None, }, @@ -10732,30 +11230,35 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_user_settings_endpoint = _Endpoint( + self.get_all_entities_user_data_filters_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserSettingOutList,), + 'response_type': (JsonApiUserDataFilterOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'get_all_entities_user_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + 'operation_id': 'get_all_entities_user_data_filters', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'user_id', + 'workspace_id', + 'origin', 'filter', + 'include', 'page', 'size', 'sort', + 'x_gdc_validate_relations', 'meta_include', ], 'required': [ - 'user_id', + 'workspace_id', ], 'nullable': [ ], 'enum': [ + 'origin', + 'include', 'meta_include', ], 'validation': [ @@ -10769,44 +11272,79 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERS": "users", + "USERGROUPS": "userGroups", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "DATASETS": "datasets", + "PARAMETERS": "parameters", + "USER": "user", + "USERGROUP": "userGroup", + "ALL": "ALL" + }, ('meta_include',): { + "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'user_id': + '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': { - 'user_id': 'userId', + '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': { - 'user_id': 'path', + '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', } @@ -10820,12 +11358,275 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_users_endpoint = _Endpoint( + self.get_all_entities_user_groups_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserOutList,), + 'response_type': (JsonApiUserGroupOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'get_all_entities_users', + 'endpoint_path': '/api/v1/entities/userGroups', + 'operation_id': 'get_all_entities_user_groups', + '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',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "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_user_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserIdentifierOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/userIdentifiers', + 'operation_id': 'get_all_entities_user_identifiers', + '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_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', + 'operation_id': 'get_all_entities_user_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'filter', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [ + 'user_id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'user_id': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'user_id': 'userId', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'user_id': 'path', + '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_users_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users', + 'operation_id': 'get_all_entities_users', 'http_method': 'GET', 'servers': None, }, @@ -13456,6 +14257,200 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'get_entity_document_templates', + '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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'get_entity_documents', + '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_entitlements_endpoint = _Endpoint( settings={ 'response_type': (JsonApiEntitlementOutDocument,), @@ -15044,6 +16039,103 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'get_entity_page_templates', + '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_parameters_endpoint = _Endpoint( settings={ 'response_type': (JsonApiParameterOutDocument,), @@ -17829,6 +18921,172 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'patch_entity_document_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_patch_document': + (JsonApiPublisherDocumentTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'patch_entity_documents', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_patch_document': + (JsonApiPublisherDocumentPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_export_definitions_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportDefinitionOutDocument,), @@ -19101,6 +20359,89 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'patch_entity_page_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_patch_document': + (JsonApiPublisherDocumentPageTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_parameters_endpoint = _Endpoint( settings={ 'response_type': (JsonApiParameterOutDocument,), @@ -23224,6 +24565,172 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'update_entity_document_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_in_document': + (JsonApiPublisherDocumentTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'update_entity_documents', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_in_document': + (JsonApiPublisherDocumentInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_export_definitions_endpoint = _Endpoint( settings={ 'response_type': (JsonApiExportDefinitionOutDocument,), @@ -24415,6 +25922,89 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.update_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'update_entity_page_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_in_document': + (JsonApiPublisherDocumentPageTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_parameters_endpoint = _Endpoint( settings={ 'response_type': (JsonApiParameterOutDocument,), @@ -26440,28 +28030,281 @@ def create_entity_computed_attributes( '_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_computed_attribute_post_optional_id_document'] = \ - json_api_computed_attribute_post_optional_id_document - return self.create_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_computed_attribute_post_optional_id_document'] = \ + json_api_computed_attribute_post_optional_id_document + return self.create_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def create_entity_csp_directives( + self, + json_api_csp_directive_in_document, + **kwargs + ): + """Post 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_csp_directives(json_api_csp_directive_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): + + 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: + JsonApiCspDirectiveOutDocument + 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_csp_directive_in_document'] = \ + json_api_csp_directive_in_document + return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + + def create_entity_custom_application_settings( + self, + workspace_id, + json_api_custom_application_setting_post_optional_id_document, + **kwargs + ): + """Post 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.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): + + 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: + 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_csp_directives( + def create_entity_custom_user_application_settings( self, - json_api_csp_directive_in_document, + user_id, + json_api_custom_user_application_setting_post_optional_id_document, **kwargs ): - """Post CSP Directives # noqa: E501 + """Post a new 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.create_entity_csp_directives(json_api_csp_directive_in_document, 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: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): + 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 @@ -26496,7 +28339,7 @@ def create_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiCustomUserApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -26525,29 +28368,32 @@ def create_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.create_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + 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_custom_application_settings( + def create_entity_dashboard_plugins( self, workspace_id, - json_api_custom_application_setting_post_optional_id_document, + json_api_dashboard_plugin_post_optional_id_document, **kwargs ): - """Post Custom Application Settings # noqa: E501 + """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_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, 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_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): + 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. @@ -26581,7 +28427,7 @@ def create_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiDashboardPluginOutDocument If the method is called asynchronously, returns the request thread. """ @@ -26612,111 +28458,29 @@ 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) - - 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) + 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_custom_user_application_settings( + def create_entity_data_sources( self, - user_id, - json_api_custom_user_application_setting_post_optional_id_document, + json_api_data_source_in_document, **kwargs ): - """Post a new custom application setting for the user # noqa: E501 + """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_custom_user_application_settings(user_id, json_api_custom_user_application_setting_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): - json_api_custom_user_application_setting_post_optional_id_document (JsonApiCustomUserApplicationSettingPostOptionalIdDocument): + 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 @@ -26749,7 +28513,7 @@ def create_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -26778,29 +28542,27 @@ 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_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_dashboard_plugins( + def create_entity_document_templates( self, workspace_id, - json_api_dashboard_plugin_post_optional_id_document, + json_api_publisher_document_template_post_optional_id_document, **kwargs ): - """Post Plugins # noqa: E501 + """Post Document 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_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + json_api_publisher_document_template_post_optional_id_document (JsonApiPublisherDocumentTemplatePostOptionalIdDocument): 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] @@ -26837,7 +28599,7 @@ def create_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiPublisherDocumentTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -26868,28 +28630,30 @@ def create_entity_dashboard_plugins( 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_publisher_document_template_post_optional_id_document'] = \ + json_api_publisher_document_template_post_optional_id_document + return self.create_entity_document_templates_endpoint.call_with_http_info(**kwargs) - def create_entity_data_sources( + def create_entity_documents( self, - json_api_data_source_in_document, + workspace_id, + json_api_publisher_document_post_optional_id_document, **kwargs ): - """Post Data Sources # noqa: E501 + """Post Document # 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_documents(workspace_id, json_api_publisher_document_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): + workspace_id (str): + json_api_publisher_document_post_optional_id_document (JsonApiPublisherDocumentPostOptionalIdDocument): 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. @@ -26923,7 +28687,7 @@ def create_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiPublisherDocumentOutDocument If the method is called asynchronously, returns the request thread. """ @@ -26952,9 +28716,11 @@ 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['workspace_id'] = \ + workspace_id + kwargs['json_api_publisher_document_post_optional_id_document'] = \ + json_api_publisher_document_post_optional_id_document + return self.create_entity_documents_endpoint.call_with_http_info(**kwargs) def create_entity_export_definitions( self, @@ -28140,9 +29906,97 @@ 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['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_page_templates( + self, + workspace_id, + json_api_publisher_document_page_template_post_optional_id_document, + **kwargs + ): + """Post Page 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_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_page_template_post_optional_id_document (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_post_optional_id_document'] = \ + json_api_publisher_document_page_template_post_optional_id_document + return self.create_entity_page_templates_endpoint.call_with_http_info(**kwargs) def create_entity_parameters( self, @@ -29948,24 +31802,278 @@ 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['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) + + def delete_entity_automations( + self, + workspace_id, + object_id, + **kwargs + ): + """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.delete_entity_automations(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_automations_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_api_tokens_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_attribute_hierarchies( + def delete_entity_computed_attributes( self, workspace_id, object_id, **kwargs ): - """Delete an Attribute Hierarchy # noqa: E501 + """Delete a Computed Attribute # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_computed_attributes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -30038,25 +32146,24 @@ def delete_entity_attribute_hierarchies( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) - def delete_entity_automations( + def delete_entity_csp_directives( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete an Automation # 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.delete_entity_automations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_csp_directives(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 @@ -30120,27 +32227,27 @@ def delete_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 - return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def delete_entity_color_palettes( + def delete_entity_custom_application_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete a Color Pallette # noqa: E501 + """Delete 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.delete_entity_color_palettes(id, async_req=True) + >>> thread = api.delete_entity_custom_application_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 @@ -30204,27 +32311,27 @@ def delete_entity_color_palettes( '_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) + 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_computed_attributes( + def delete_entity_custom_geo_collections( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Computed Attribute # noqa: E501 + """Delete 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.delete_entity_computed_attributes(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_custom_geo_collections(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 @@ -30288,27 +32395,26 @@ def delete_entity_computed_attributes( '_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_computed_attributes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def delete_entity_csp_directives( + def delete_entity_custom_user_application_settings( self, + user_id, id, **kwargs ): - """Delete CSP Directives # noqa: E501 + """Delete a custom application setting 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.delete_entity_csp_directives(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: @@ -30373,22 +32479,24 @@ def delete_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 - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_application_settings( + def delete_entity_dashboard_plugins( self, workspace_id, object_id, **kwargs ): - """Delete a Custom Application Setting # 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_custom_application_settings(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -30461,19 +32569,20 @@ 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_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_geo_collections( + def delete_entity_data_sources( self, id, **kwargs ): - """Delete Custom Geo Collection # 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_custom_geo_collections(id, async_req=True) + >>> thread = api.delete_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: @@ -30543,25 +32652,25 @@ 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_data_sources_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_user_application_settings( + def delete_entity_document_templates( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Delete a custom application setting for a user # noqa: E501 + """Delete a Document 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_custom_user_application_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_document_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 @@ -30625,24 +32734,24 @@ 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) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_document_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_dashboard_plugins( + def delete_entity_documents( self, workspace_id, object_id, **kwargs ): - """Delete a Plugin # noqa: E501 + """Delete a Document # 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) + >>> thread = api.delete_entity_documents(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -30715,24 +32824,25 @@ def delete_entity_dashboard_plugins( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_documents_endpoint.call_with_http_info(**kwargs) - def delete_entity_data_sources( + def delete_entity_export_definitions( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Data Source entity # noqa: E501 + """Delete an Export Definition # 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_data_sources(id, async_req=True) + >>> thread = api.delete_entity_export_definitions(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 @@ -30796,27 +32906,27 @@ def delete_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_definitions( + def delete_entity_export_templates( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete an Export Definition # 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_export_definitions(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_export_templates(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 @@ -30880,27 +32990,27 @@ def delete_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 - return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_templates( + def delete_entity_filter_contexts( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Export Template entity # noqa: E501 + """Delete 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.delete_entity_export_templates(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 @@ -30964,22 +33074,24 @@ 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) + 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_filter_contexts( + def delete_entity_filter_views( self, workspace_id, object_id, **kwargs ): - """Delete a Filter Context # 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_filter_contexts(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -31052,25 +33164,23 @@ 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_filter_views_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_views( + def delete_entity_identity_providers( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete Filter view # 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_filter_views(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_identity_providers(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 @@ -31134,23 +33244,21 @@ def delete_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['object_id'] = \ - object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_identity_providers( + def delete_entity_ip_allowlist_policies( self, id, **kwargs ): - """Delete Identity Provider # 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_identity_providers(id, async_req=True) + >>> thread = api.delete_entity_ip_allowlist_policies(id, async_req=True) >>> result = thread.get() Args: @@ -31220,19 +33328,20 @@ 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_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def delete_entity_ip_allowlist_policies( + def delete_entity_jwks( self, id, **kwargs ): - """Delete IpAllowlistPolicy entity # noqa: E501 + """Delete Jwk # 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_ip_allowlist_policies(id, async_req=True) + >>> thread = api.delete_entity_jwks(id, async_req=True) >>> result = thread.get() Args: @@ -31302,24 +33411,25 @@ 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_jwks_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( + def delete_entity_knowledge_recommendations( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Jwk # noqa: E501 + """Delete a Knowledge Recommendation # 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_knowledge_recommendations(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 @@ -31383,27 +33493,27 @@ def delete_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + 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_llm_providers( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Knowledge Recommendation # 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_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_llm_providers(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 @@ -31467,27 +33577,27 @@ def delete_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.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_providers( + def delete_entity_memory_items( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete LLM Provider entity # 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_llm_providers(id, async_req=True) + >>> thread = api.delete_entity_memory_items(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 @@ -31551,22 +33661,24 @@ def delete_entity_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def delete_entity_memory_items( + def delete_entity_metrics( self, workspace_id, object_id, **kwargs ): - """Delete a Memory Item # 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_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -31639,25 +33751,23 @@ 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_metrics_endpoint.call_with_http_info(**kwargs) - def delete_entity_metrics( + def delete_entity_notification_channels( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Metric # 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_metrics(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_notification_channels(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 @@ -31721,23 +33831,21 @@ 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_notification_channels_endpoint.call_with_http_info(**kwargs) - def delete_entity_notification_channels( + def delete_entity_org_memory_items( self, id, **kwargs ): - """Delete Notification Channel 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_notification_channels(id, async_req=True) + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) >>> result = thread.get() Args: @@ -31807,19 +33915,19 @@ def delete_entity_notification_channels( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def delete_entity_org_memory_items( + def delete_entity_organization_settings( self, id, **kwargs ): - """Delete an organization Memory Item entity # noqa: E501 + """Delete 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.delete_entity_org_memory_items(id, async_req=True) + >>> thread = api.delete_entity_organization_settings(id, async_req=True) >>> result = thread.get() Args: @@ -31889,23 +33997,25 @@ def delete_entity_org_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_organization_settings( + def delete_entity_page_templates( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Organization Setting entity # noqa: E501 + """Delete a Page 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_organization_settings(id, async_req=True) + >>> thread = api.delete_entity_page_templates(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 @@ -31969,9 +34079,11 @@ def delete_entity_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_page_templates_endpoint.call_with_http_info(**kwargs) def delete_entity_parameters( self, @@ -32566,25 +34678,194 @@ def delete_entity_user_groups( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + + def delete_entity_user_settings( + self, + user_id, + id, + **kwargs + ): + """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_user_settings(user_id, id, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + 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['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_users( + self, + id, + **kwargs + ): + """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_users(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_users_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_settings( + def delete_entity_visualization_objects( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Delete a setting for a user # 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_user_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_visualization_objects(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 @@ -32648,28 +34929,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_visualization_objects_endpoint.call_with_http_info(**kwargs) - def delete_entity_users( + def delete_entity_workspace_color_palettes( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete User entity # noqa: E501 + """Delete a Workspace Color Palette # 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_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 @@ -32733,22 +35015,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_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_visualization_objects( + def delete_entity_workspace_data_filter_settings( self, workspace_id, object_id, **kwargs ): - """Delete a Visualization Object # 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_visualization_objects(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: @@ -32821,20 +35105,20 @@ 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_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_color_palettes( + def delete_entity_workspace_data_filters( self, workspace_id, object_id, **kwargs ): - """Delete a Workspace Color Palette # noqa: E501 + """Delete 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.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -32907,20 +35191,20 @@ def delete_entity_workspace_color_palettes( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filter_settings( + def delete_entity_workspace_export_templates( self, workspace_id, object_id, **kwargs ): - """Delete a Settings for Workspace Data Filter # 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_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_export_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -32993,20 +35277,20 @@ def delete_entity_workspace_data_filter_settings( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filters( + def delete_entity_workspace_settings( self, workspace_id, object_id, **kwargs ): - """Delete a Workspace Data Filter # noqa: E501 + """Delete 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.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -33079,20 +35363,20 @@ def delete_entity_workspace_data_filters( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_export_templates( + def delete_entity_workspace_themes( self, workspace_id, object_id, **kwargs ): - """Delete a Workspace Export Template # 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_workspace_export_templates(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -33165,25 +35449,24 @@ def delete_entity_workspace_export_templates( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_settings( + def delete_entity_workspaces( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Setting for Workspace # 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_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 @@ -33247,31 +35530,30 @@ 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) + kwargs['id'] = \ + id + return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_themes( + def get_all_automations_workspace_automations( self, - workspace_id, - object_id, **kwargs ): - """Delete a Workspace Theme # 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_themes(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 @@ -33304,7 +35586,7 @@ def delete_entity_workspace_themes( async_req (bool): execute request asynchronously Returns: - None + JsonApiWorkspaceAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -33333,28 +35615,21 @@ def delete_entity_workspace_themes( '_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) + return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspaces( + def get_all_entities( self, - id, **kwargs ): - """Delete Workspace entity # noqa: E501 + """Get all LLM endpoint entities (Removed) # noqa: E501 - Space of the shared interest # 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_workspaces(id, async_req=True) + >>> thread = api.get_all_entities(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -33418,20 +35693,18 @@ 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_endpoint.call_with_http_info(**kwargs) - def get_all_automations_workspace_automations( + def get_all_entities_agents( self, **kwargs ): - """Get all Automations across all Workspaces # noqa: E501 + """Get all Agent 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_automations_workspace_automations(async_req=True) + >>> thread = api.get_all_entities_agents(async_req=True) >>> result = thread.get() @@ -33474,7 +35747,7 @@ def get_all_automations_workspace_automations( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceAutomationOutList + JsonApiAgentOutList If the method is called asynchronously, returns the request thread. """ @@ -33503,23 +35776,33 @@ 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) + return self.get_all_entities_agents_endpoint.call_with_http_info(**kwargs) - def get_all_entities( + def get_all_entities_aggregated_facts( self, + workspace_id, **kwargs ): - """Get all LLM endpoint entities (Removed) # noqa: E501 + """Get all Aggregated Facts # 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_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. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -33552,7 +35835,7 @@ def get_all_entities( async_req (bool): execute request asynchronously Returns: - None + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -33581,27 +35864,34 @@ 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_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_agents( + def get_all_entities_analytical_dashboards( self, + workspace_id, **kwargs ): - """Get all Agent entities # noqa: E501 + """Get all 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.get_all_entities_agents(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. @@ -33635,7 +35925,7 @@ def get_all_entities_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutList + JsonApiAnalyticalDashboardOutList If the method is called asynchronously, returns the request thread. """ @@ -33664,32 +35954,31 @@ 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['workspace_id'] = \ + workspace_id + return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def get_all_entities_aggregated_facts( + def get_all_entities_api_tokens( self, - workspace_id, + user_id, **kwargs ): - """Get all Aggregated Facts # 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_aggregated_facts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_api_tokens(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. @@ -33723,7 +36012,7 @@ def get_all_entities_aggregated_facts( async_req (bool): execute request asynchronously Returns: - JsonApiAggregatedFactOutList + JsonApiApiTokenOutList If the method is called asynchronously, returns the request thread. """ @@ -33752,21 +36041,21 @@ def get_all_entities_aggregated_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_aggregated_facts_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_analytical_dashboards( + def get_all_entities_attribute_hierarchies( self, workspace_id, **kwargs ): - """Get all Dashboards # 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_analytical_dashboards(workspace_id, async_req=True) + >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -33813,7 +36102,7 @@ def get_all_entities_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutList + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -33844,29 +36133,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_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_api_tokens( + def get_all_entities_attributes( self, - user_id, + workspace_id, **kwargs ): - """List all api tokens for a user # 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_api_tokens(user_id, async_req=True) + >>> thread = api.get_all_entities_attributes(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. @@ -33900,7 +36192,7 @@ def get_all_entities_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutList + JsonApiAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -33929,21 +36221,21 @@ 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_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attribute_hierarchies( + def get_all_entities_automations( self, workspace_id, **kwargs ): - """Get all Attribute Hierarchies # 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_attribute_hierarchies(workspace_id, async_req=True) + >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -33990,7 +36282,7 @@ def get_all_entities_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutList + JsonApiAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -34021,32 +36313,26 @@ def get_all_entities_attribute_hierarchies( 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_automations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attributes( + def get_all_entities_color_palettes( self, - workspace_id, **kwargs ): - """Get all Attributes # 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_attributes(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. @@ -34080,7 +36366,7 @@ def get_all_entities_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutList + JsonApiColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -34109,21 +36395,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_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_automations( + def get_all_entities_computed_attributes( self, workspace_id, **kwargs ): - """Get all Automations # noqa: E501 + """Get all Computed 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_automations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_computed_attributes(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -34170,7 +36454,7 @@ def get_all_entities_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutList + JsonApiComputedAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -34201,18 +36485,19 @@ 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_computed_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_color_palettes( + def get_all_entities_csp_directives( self, **kwargs ): - """Get all Color Pallettes # 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_color_palettes(async_req=True) + >>> thread = api.get_all_entities_csp_directives(async_req=True) >>> result = thread.get() @@ -34254,7 +36539,7 @@ def get_all_entities_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutList + JsonApiCspDirectiveOutList If the method is called asynchronously, returns the request thread. """ @@ -34283,19 +36568,19 @@ 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_csp_directives_endpoint.call_with_http_info(**kwargs) - def get_all_entities_computed_attributes( + def get_all_entities_custom_application_settings( self, workspace_id, **kwargs ): - """Get all Computed Attributes # 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_computed_attributes(workspace_id, async_req=True) + >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -34304,7 +36589,6 @@ def get_all_entities_computed_attributes( 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] @@ -34342,7 +36626,7 @@ def get_all_entities_computed_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiComputedAttributeOutList + JsonApiCustomApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -34373,19 +36657,18 @@ def get_all_entities_computed_attributes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_computed_attributes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_csp_directives( + def get_all_entities_custom_geo_collections( self, **kwargs ): - """Get CSP Directives # noqa: E501 + """Get all Custom Geo Collections # 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_geo_collections(async_req=True) >>> result = thread.get() @@ -34427,7 +36710,7 @@ def get_all_entities_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutList + JsonApiCustomGeoCollectionOutList If the method is called asynchronously, returns the request thread. """ @@ -34456,31 +36739,29 @@ 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) + return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_application_settings( + def get_all_entities_custom_user_application_settings( self, - workspace_id, + user_id, **kwargs ): - """Get all Custom Application Settings # noqa: E501 + """List all custom application 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_custom_application_settings(workspace_id, async_req=True) + >>> thread = api.get_all_entities_custom_user_application_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] 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. @@ -34514,7 +36795,7 @@ def get_all_entities_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutList + JsonApiCustomUserApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -34543,28 +36824,34 @@ def get_all_entities_custom_application_settings( '_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_custom_application_settings_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_geo_collections( + def get_all_entities_dashboard_plugins( self, + workspace_id, **kwargs ): - """Get all Custom Geo Collections # 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_geo_collections(async_req=True) + >>> thread = api.get_all_entities_dashboard_plugins(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. @@ -34598,7 +36885,7 @@ def get_all_entities_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutList + JsonApiDashboardPluginOutList If the method is called asynchronously, returns the request thread. """ @@ -34627,23 +36914,22 @@ 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) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_user_application_settings( + def get_all_entities_data_source_identifiers( self, - user_id, **kwargs ): - """List all custom application settings for a user # 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_user_application_settings(user_id, async_req=True) + >>> thread = api.get_all_entities_data_source_identifiers(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] @@ -34683,7 +36969,7 @@ def get_all_entities_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutList + JsonApiDataSourceIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -34712,34 +36998,27 @@ 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_source_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_dashboard_plugins( + def get_all_entities_data_sources( self, - workspace_id, **kwargs ): - """Get all Plugins # 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_dashboard_plugins(workspace_id, async_req=True) + >>> thread = api.get_all_entities_data_sources(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. @@ -34773,7 +37052,7 @@ def get_all_entities_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutList + JsonApiDataSourceOutList If the method is called asynchronously, returns the request thread. """ @@ -34802,28 +37081,32 @@ def get_all_entities_dashboard_plugins( '_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_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_source_identifiers( + def get_all_entities_datasets( self, + workspace_id, **kwargs ): - """Get all Data Source Identifiers # 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_data_source_identifiers(async_req=True) + >>> thread = api.get_all_entities_datasets(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. @@ -34857,7 +37140,7 @@ def get_all_entities_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutList + JsonApiDatasetOutList If the method is called asynchronously, returns the request thread. """ @@ -34886,27 +37169,34 @@ 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) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_sources( + def get_all_entities_document_templates( self, + workspace_id, **kwargs ): - """Get Data Source entities # noqa: E501 + """Get all Document Templates # 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_document_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] + 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. @@ -34940,7 +37230,7 @@ def get_all_entities_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutList + JsonApiPublisherDocumentTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -34969,19 +37259,21 @@ 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) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_document_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_datasets( + def get_all_entities_documents( self, workspace_id, **kwargs ): - """Get all Datasets # noqa: E501 + """Get all Documents # 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_documents(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -35028,7 +37320,7 @@ def get_all_entities_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutList + JsonApiPublisherDocumentOutList If the method is called asynchronously, returns the request thread. """ @@ -35059,7 +37351,7 @@ 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_documents_endpoint.call_with_http_info(**kwargs) def get_all_entities_entitlements( self, @@ -36692,7 +38984,97 @@ 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) + return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_page_templates( + self, + workspace_id, + **kwargs + ): + """Get all Page 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_page_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] + 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 + 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: + JsonApiPublisherDocumentPageTemplateOutList + 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_page_templates_endpoint.call_with_http_info(**kwargs) def get_all_entities_parameters( self, @@ -40082,6 +42464,186 @@ def get_entity_datasets( object_id return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) + def get_entity_document_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document 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_document_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] + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_document_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_documents( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document # 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_documents(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: + JsonApiPublisherDocumentOutDocument + 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_documents_endpoint.call_with_http_info(**kwargs) + def get_entity_entitlements( self, id, @@ -41804,9 +44366,99 @@ def get_entity_organizations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) + + def get_entity_page_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Page 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_page_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] + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_page_templates_endpoint.call_with_http_info(**kwargs) def get_entity_parameters( self, @@ -44816,6 +47468,190 @@ def patch_entity_datasets( json_api_dataset_patch_document return self.patch_entity_datasets_endpoint.call_with_http_info(**kwargs) + def patch_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_patch_document, + **kwargs + ): + """Patch a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_patch_document (JsonApiPublisherDocumentTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_patch_document'] = \ + json_api_publisher_document_template_patch_document + return self.patch_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_patch_document, + **kwargs + ): + """Patch a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_patch_document (JsonApiPublisherDocumentPatchDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_patch_document'] = \ + json_api_publisher_document_patch_document + return self.patch_entity_documents_endpoint.call_with_http_info(**kwargs) + def patch_entity_export_definitions( self, workspace_id, @@ -46245,11 +49081,103 @@ def patch_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_patch_document'] = \ - json_api_organization_patch_document - return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_organization_patch_document'] = \ + json_api_organization_patch_document + return self.patch_entity_organizations_endpoint.call_with_http_info(**kwargs) + + def patch_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_patch_document, + **kwargs + ): + """Patch a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_patch_document (JsonApiPublisherDocumentPageTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_patch_document'] = \ + json_api_publisher_document_page_template_patch_document + return self.patch_entity_page_templates_endpoint.call_with_http_info(**kwargs) def patch_entity_parameters( self, @@ -51067,6 +53995,190 @@ def update_entity_data_sources( json_api_data_source_in_document return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) + def update_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_in_document, + **kwargs + ): + """Put a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_in_document (JsonApiPublisherDocumentTemplateInDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_in_document'] = \ + json_api_publisher_document_template_in_document + return self.update_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_in_document, + **kwargs + ): + """Put a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_in_document (JsonApiPublisherDocumentInDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_in_document'] = \ + json_api_publisher_document_in_document + return self.update_entity_documents_endpoint.call_with_http_info(**kwargs) + def update_entity_export_definitions( self, workspace_id, @@ -52406,6 +55518,98 @@ def update_entity_organizations( json_api_organization_in_document return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + def update_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_in_document, + **kwargs + ): + """Put a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_in_document (JsonApiPublisherDocumentPageTemplateInDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_in_document'] = \ + json_api_publisher_document_page_template_in_document + return self.update_entity_page_templates_endpoint.call_with_http_info(**kwargs) + def update_entity_parameters( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/image_export_api.py b/gooddata-api-client/gooddata_api_client/api/image_export_api.py index 7c1d6b021..992675d4a 100644 --- a/gooddata-api-client/gooddata_api_client/api/image_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/image_export_api.py @@ -23,7 +23,7 @@ validate_and_convert_types ) from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.image_export_request import ImageExportRequest diff --git a/gooddata-api-client/gooddata_api_client/api/localization_api.py b/gooddata-api-client/gooddata_api_client/api/localization_api.py new file mode 100644 index 000000000..b591ebd91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/localization_api.py @@ -0,0 +1,1078 @@ +""" + 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.localization_statistics import LocalizationStatistics +from gooddata_api_client.model.localization_usage import LocalizationUsage +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces +from gooddata_api_client.model.workspace_localization_usage import WorkspaceLocalizationUsage + + +class LocalizationApi(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.organization_localization_statistics_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationStatistics,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/statistics', + 'operation_id': 'organization_localization_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsage,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage', + 'operation_id': 'organization_localization_usage', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_users_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageUsers,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage/users', + 'operation_id': 'organization_localization_usage_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.organization_localization_usage_workspaces_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageWorkspaces,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/localization/usage/workspaces', + 'operation_id': 'organization_localization_usage_workspaces', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_localization_statistics_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationStatistics,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/statistics', + 'operation_id': 'workspace_localization_statistics', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_localization_usage_endpoint = _Endpoint( + settings={ + 'response_type': (WorkspaceLocalizationUsage,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage', + 'operation_id': 'workspace_localization_usage', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.workspace_localization_usage_users_endpoint = _Endpoint( + settings={ + 'response_type': (LocalizationUsageUsers,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/localization/usage/users', + 'operation_id': 'workspace_localization_usage_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'value', + 'name', + 'setting', + 'source', + 'page', + 'size', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'setting', + 'source', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('setting',): { + + "LOCALE": "LOCALE", + "METADATA_LOCALE": "METADATA_LOCALE", + "DATA_LOCALE": "DATA_LOCALE" + }, + ('source',): { + + "USER": "USER", + "WORKSPACE": "WORKSPACE", + "PARENT": "PARENT", + "ORGANIZATION": "ORGANIZATION", + "ENVIRONMENT": "ENVIRONMENT", + "DEFAULT": "DEFAULT" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'value': + (str,), + 'name': + (str,), + 'setting': + (str,), + 'source': + (str,), + 'page': + (int,), + 'size': + (int,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'value': 'value', + 'name': 'name', + 'setting': 'setting', + 'source': 'source', + 'page': 'page', + 'size': 'size', + }, + 'location_map': { + 'workspace_id': 'path', + 'value': 'query', + 'name': 'query', + 'setting': 'query', + 'source': 'query', + 'page': 'query', + 'size': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def organization_localization_statistics( + self, + **kwargs + ): + """(BETA) Languages with translations in the organization. # noqa: E501 + + (BETA) Lists the languages that have at least one translation, separately for each kind of translation. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_statistics(async_req=True) + >>> 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: + LocalizationStatistics + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_statistics_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage( + self, + **kwargs + ): + """(BETA) Languages used in the organization. # noqa: E501 + + (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationUsage + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_usage_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage_users( + self, + **kwargs + ): + """(BETA) Users who set a language themselves. # noqa: E501 + + (BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage_users(async_req=True) + >>> result = thread.get() + + + Keyword Args: + value (str): Language tag that the user sets.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + 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: + LocalizationUsageUsers + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_usage_users_endpoint.call_with_http_info(**kwargs) + + def organization_localization_usage_workspaces( + self, + **kwargs + ): + """(BETA) Workspaces that use a language. # noqa: E501 + + (BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.organization_localization_usage_workspaces(async_req=True) + >>> result = thread.get() + + + Keyword Args: + value (str): Language tag that the workspace gets.. [optional] + name (str): Filter by workspace name. Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationUsageWorkspaces + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.organization_localization_usage_workspaces_endpoint.call_with_http_info(**kwargs) + + def workspace_localization_statistics( + self, + workspace_id, + **kwargs + ): + """(BETA) Languages with translations in the workspace. # noqa: E501 + + (BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_statistics(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationStatistics + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_statistics_endpoint.call_with_http_info(**kwargs) + + def workspace_localization_usage( + self, + workspace_id, + **kwargs + ): + """(BETA) Languages used in the workspace. # noqa: E501 + + (BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + WorkspaceLocalizationUsage + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_usage_endpoint.call_with_http_info(**kwargs) + + def workspace_localization_usage_users( + self, + workspace_id, + **kwargs + ): + """(BETA) Workspace members who get a language. # noqa: E501 + + (BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.workspace_localization_usage_users(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + value (str): Language tag that the user gets.. [optional] + name (str): Filter by user name, email or login (user ID). Note that the filter is case insensitive.. [optional] + setting (str): One of LOCALE, METADATA_LOCALE and DATA_LOCALE.. [optional] + source (str): Where the value comes from.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned.. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + LocalizationUsageUsers + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.workspace_localization_usage_users_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/page_template_controller_api.py b/gooddata-api-client/gooddata_api_client/api/page_template_controller_api.py new file mode 100644 index 000000000..77225217d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/page_template_controller_api.py @@ -0,0 +1,1106 @@ +""" + 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_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument + + +class PageTemplateControllerApi(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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'create_entity_page_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_page_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_page_template_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_page_template_post_optional_id_document': + (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_page_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'delete_entity_page_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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'get_all_entities_page_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'get_entity_page_templates', + '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.patch_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'patch_entity_page_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_patch_document': + (JsonApiPublisherDocumentPageTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'update_entity_page_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_in_document': + (JsonApiPublisherDocumentPageTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_page_templates( + self, + workspace_id, + json_api_publisher_document_page_template_post_optional_id_document, + **kwargs + ): + """Post Page 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_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_page_template_post_optional_id_document (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_post_optional_id_document'] = \ + json_api_publisher_document_page_template_post_optional_id_document + return self.create_entity_page_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_page_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Page 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_page_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_page_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_page_templates( + self, + workspace_id, + **kwargs + ): + """Get all Page 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_page_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] + 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 + 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: + JsonApiPublisherDocumentPageTemplateOutList + 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_page_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_page_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Page 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_page_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] + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_page_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_patch_document, + **kwargs + ): + """Patch a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_patch_document (JsonApiPublisherDocumentPageTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_patch_document'] = \ + json_api_publisher_document_page_template_patch_document + return self.patch_entity_page_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_in_document, + **kwargs + ): + """Put a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_in_document (JsonApiPublisherDocumentPageTemplateInDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_in_document'] = \ + json_api_publisher_document_page_template_in_document + return self.update_entity_page_templates_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py b/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py new file mode 100644 index 000000000..13bb9c90c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/publisher_documents_api.py @@ -0,0 +1,3242 @@ +""" + 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_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument + + +class PublisherDocumentsApi(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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'create_entity_document_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_template_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_template_post_optional_id_document': + (JsonApiPublisherDocumentTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'create_entity_documents', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_post_optional_id_document': + (JsonApiPublisherDocumentPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'create_entity_page_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_publisher_document_page_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_publisher_document_page_template_post_optional_id_document', + ], + '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,), + 'json_api_publisher_document_page_template_post_optional_id_document': + (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_publisher_document_page_template_post_optional_id_document': 'body', + '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': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'delete_entity_document_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.delete_entity_documents_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'delete_entity_documents', + '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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'delete_entity_page_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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates', + 'operation_id': 'get_all_entities_document_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents', + 'operation_id': 'get_all_entities_documents', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates', + 'operation_id': 'get_all_entities_page_templates', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + '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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'get_entity_document_templates', + '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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'get_entity_documents', + '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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'get_entity_page_templates', + '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.patch_entity_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'patch_entity_document_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_patch_document': + (JsonApiPublisherDocumentTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'patch_entity_documents', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_patch_document': + (JsonApiPublisherDocumentPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'patch_entity_page_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_patch_document': + (JsonApiPublisherDocumentPageTemplatePatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_document_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}', + 'operation_id': 'update_entity_document_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_template_in_document': + (JsonApiPublisherDocumentTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_template_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_documents_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}', + 'operation_id': 'update_entity_documents', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_in_document': + (JsonApiPublisherDocumentInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_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_page_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiPublisherDocumentPageTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}', + 'operation_id': 'update_entity_page_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_publisher_document_page_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_publisher_document_page_template_in_document': + (JsonApiPublisherDocumentPageTemplateInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_publisher_document_page_template_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_document_templates( + self, + workspace_id, + json_api_publisher_document_template_post_optional_id_document, + **kwargs + ): + """Post Document 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_document_templates(workspace_id, json_api_publisher_document_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_template_post_optional_id_document (JsonApiPublisherDocumentTemplatePostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_post_optional_id_document'] = \ + json_api_publisher_document_template_post_optional_id_document + return self.create_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def create_entity_documents( + self, + workspace_id, + json_api_publisher_document_post_optional_id_document, + **kwargs + ): + """Post Document # 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_documents(workspace_id, json_api_publisher_document_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_post_optional_id_document (JsonApiPublisherDocumentPostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_post_optional_id_document'] = \ + json_api_publisher_document_post_optional_id_document + return self.create_entity_documents_endpoint.call_with_http_info(**kwargs) + + def create_entity_page_templates( + self, + workspace_id, + json_api_publisher_document_page_template_post_optional_id_document, + **kwargs + ): + """Post Page 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_page_templates(workspace_id, json_api_publisher_document_page_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_publisher_document_page_template_post_optional_id_document (JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_post_optional_id_document'] = \ + json_api_publisher_document_page_template_post_optional_id_document + return self.create_entity_page_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_document_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Document 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_document_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_document_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_documents( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Document # 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_documents(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_documents_endpoint.call_with_http_info(**kwargs) + + def delete_entity_page_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Page 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_page_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_page_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_document_templates( + self, + workspace_id, + **kwargs + ): + """Get all Document 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_document_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] + 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 + 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: + JsonApiPublisherDocumentTemplateOutList + 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_document_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_documents( + self, + workspace_id, + **kwargs + ): + """Get all Documents # 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_documents(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 + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiPublisherDocumentOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_documents_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_page_templates( + self, + workspace_id, + **kwargs + ): + """Get all Page 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_page_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] + 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 + 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: + JsonApiPublisherDocumentPageTemplateOutList + 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_page_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_document_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document 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_document_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] + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_document_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_documents( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Document # 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_documents(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: + JsonApiPublisherDocumentOutDocument + 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_documents_endpoint.call_with_http_info(**kwargs) + + def get_entity_page_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Page 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_page_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] + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_page_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_patch_document, + **kwargs + ): + """Patch a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_patch_document (JsonApiPublisherDocumentTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_patch_document'] = \ + json_api_publisher_document_template_patch_document + return self.patch_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_patch_document, + **kwargs + ): + """Patch a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_patch_document (JsonApiPublisherDocumentPatchDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_patch_document'] = \ + json_api_publisher_document_patch_document + return self.patch_entity_documents_endpoint.call_with_http_info(**kwargs) + + def patch_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_patch_document, + **kwargs + ): + """Patch a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_patch_document (JsonApiPublisherDocumentPageTemplatePatchDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_patch_document'] = \ + json_api_publisher_document_page_template_patch_document + return self.patch_entity_page_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_document_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_template_in_document, + **kwargs + ): + """Put a Document 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_document_templates(workspace_id, object_id, json_api_publisher_document_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_template_in_document (JsonApiPublisherDocumentTemplateInDocument): + + 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: + JsonApiPublisherDocumentTemplateOutDocument + 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_publisher_document_template_in_document'] = \ + json_api_publisher_document_template_in_document + return self.update_entity_document_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_documents( + self, + workspace_id, + object_id, + json_api_publisher_document_in_document, + **kwargs + ): + """Put a Document # 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_documents(workspace_id, object_id, json_api_publisher_document_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_in_document (JsonApiPublisherDocumentInDocument): + + 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: + JsonApiPublisherDocumentOutDocument + 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_publisher_document_in_document'] = \ + json_api_publisher_document_in_document + return self.update_entity_documents_endpoint.call_with_http_info(**kwargs) + + def update_entity_page_templates( + self, + workspace_id, + object_id, + json_api_publisher_document_page_template_in_document, + **kwargs + ): + """Put a Page 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_page_templates(workspace_id, object_id, json_api_publisher_document_page_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_publisher_document_page_template_in_document (JsonApiPublisherDocumentPageTemplateInDocument): + + 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: + JsonApiPublisherDocumentPageTemplateOutDocument + 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_publisher_document_page_template_in_document'] = \ + json_api_publisher_document_page_template_in_document + return self.update_entity_page_templates_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/report_export_api.py b/gooddata-api-client/gooddata_api_client/api/report_export_api.py index 5438f4b44..258624dc1 100644 --- a/gooddata-api-client/gooddata_api_client/api/report_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/report_export_api.py @@ -23,7 +23,7 @@ validate_and_convert_types ) from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.report_export_request import ReportExportRequest @@ -38,6 +38,67 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.create_document_export_endpoint = _Endpoint( + settings={ + 'response_type': (ExportResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document', + 'operation_id': 'create_document_export', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'report_export_request', + 'x_gdc_debug', + ], + 'required': [ + 'workspace_id', + 'report_export_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'report_export_request': + (ReportExportRequest,), + 'x_gdc_debug': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', + }, + 'location_map': { + 'workspace_id': 'path', + 'report_export_request': 'body', + 'x_gdc_debug': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.create_report_export_endpoint = _Endpoint( settings={ 'response_type': (ExportResponse,), @@ -99,6 +160,116 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_document_export_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}', + 'operation_id': 'get_document_export', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'export_id', + ], + 'required': [ + 'workspace_id', + 'export_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'export_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'export_id': 'exportId', + }, + 'location_map': { + 'workspace_id': 'path', + 'export_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/pdf' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_document_export_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata', + 'operation_id': 'get_document_export_metadata', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'export_id', + ], + 'required': [ + 'workspace_id', + 'export_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'export_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'export_id': 'exportId', + }, + 'location_map': { + 'workspace_id': 'path', + 'export_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_report_export_endpoint = _Endpoint( settings={ 'response_type': (file_type,), @@ -210,6 +381,94 @@ def __init__(self, api_client=None): api_client=api_client ) + def create_document_export( + self, + workspace_id, + report_export_request, + **kwargs + ): + """(EXPERIMENTAL) Create document export request # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_document_export(workspace_id, report_export_request, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + report_export_request (ReportExportRequest): + + Keyword Args: + x_gdc_debug (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: + ExportResponse + 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['report_export_request'] = \ + report_export_request + return self.create_document_export_endpoint.call_with_http_info(**kwargs) + def create_report_export( self, workspace_id, @@ -218,7 +477,7 @@ def create_report_export( ): """(EXPERIMENTAL) Create report export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 + Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -298,6 +557,180 @@ def create_report_export( report_export_request return self.create_report_export_endpoint.call_with_http_info(**kwargs) + def get_document_export( + self, + workspace_id, + export_id, + **kwargs + ): + """(EXPERIMENTAL) Retrieve exported document # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_document_export(workspace_id, export_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + export_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: + file_type + 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['export_id'] = \ + export_id + return self.get_document_export_endpoint.call_with_http_info(**kwargs) + + def get_document_export_metadata( + self, + workspace_id, + export_id, + **kwargs + ): + """(EXPERIMENTAL) Retrieve document export metadata # noqa: E501 + + Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified. # 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_document_export_metadata(workspace_id, export_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + export_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['export_id'] = \ + export_id + return self.get_document_export_metadata_endpoint.call_with_http_info(**kwargs) + def get_report_export( self, workspace_id, @@ -306,7 +739,7 @@ def get_report_export( ): """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -393,7 +826,7 @@ def get_report_export_metadata( ): """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. # noqa: E501 + Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py index 5dd5deeeb..f35d4a4fe 100644 --- a/gooddata-api-client/gooddata_api_client/api/slides_export_api.py +++ b/gooddata-api-client/gooddata_api_client/api/slides_export_api.py @@ -23,7 +23,7 @@ validate_and_convert_types ) from gooddata_api_client.model.export_response import ExportResponse -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.slides_export_request import SlidesExportRequest diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index a692450cf..f9d754e15 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -64,6 +64,7 @@ from gooddata_api_client.api.llm_endpoints_api import LLMEndpointsApi from gooddata_api_client.api.llm_providers_api import LLMProvidersApi from gooddata_api_client.api.labels_api import LabelsApi +from gooddata_api_client.api.localization_api import LocalizationApi from gooddata_api_client.api.manage_permissions_api import ManagePermissionsApi from gooddata_api_client.api.memory_items_api import MemoryItemsApi from gooddata_api_client.api.metadata_synchronization_api import MetadataSynchronizationApi @@ -77,6 +78,7 @@ from gooddata_api_client.api.parameters_api import ParametersApi from gooddata_api_client.api.permissions_api import PermissionsApi from gooddata_api_client.api.plugins_api import PluginsApi +from gooddata_api_client.api.publisher_documents_api import PublisherDocumentsApi from gooddata_api_client.api.raw_export_api import RawExportApi from gooddata_api_client.api.report_export_api import ReportExportApi from gooddata_api_client.api.reporting_settings_api import ReportingSettingsApi @@ -124,6 +126,8 @@ from gooddata_api_client.api.data_source_controller_api import DataSourceControllerApi from gooddata_api_client.api.data_source_identifier_controller_api import DataSourceIdentifierControllerApi from gooddata_api_client.api.dataset_controller_api import DatasetControllerApi +from gooddata_api_client.api.document_controller_api import DocumentControllerApi +from gooddata_api_client.api.document_template_controller_api import DocumentTemplateControllerApi from gooddata_api_client.api.entities_api import EntitiesApi from gooddata_api_client.api.entitlement_entity_controller_api import EntitlementEntityControllerApi from gooddata_api_client.api.export_definition_controller_api import ExportDefinitionControllerApi @@ -146,6 +150,7 @@ 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.page_template_controller_api import PageTemplateControllerApi from gooddata_api_client.api.parameter_controller_api import ParameterControllerApi from gooddata_api_client.api.report_controller_api import ReportControllerApi from gooddata_api_client.api.report_page_layout_controller_api import ReportPageLayoutControllerApi diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period.py b/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period.py new file mode 100644 index 000000000..314a22dc9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period.py @@ -0,0 +1,342 @@ +""" + 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_publisher_document_period_all_of import AbsolutePublisherDocumentPeriodAllOf + globals()['AbsolutePublisherDocumentPeriodAllOf'] = AbsolutePublisherDocumentPeriodAllOf + + +class AbsolutePublisherDocumentPeriod(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',): { + 'ABSOLUTE': "absolute", + }, + ('granularity',): { + 'GDC.TIME.DATE': "GDC.time.date", + }, + } + + 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 + '_from': (date,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (date,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AbsolutePublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "absolute", must be one of ["absolute", ] # noqa: E501 + _from (date): First day of the period, inclusive. + granularity (str): Date granularity of the period.. defaults to "GDC.time.date", must be one of ["GDC.time.date", ] # noqa: E501 + to (date): Last day of the period, inclusive. + _check_type (bool): 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', "absolute") + granularity = kwargs.get('granularity', "GDC.time.date") + _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 + """AbsolutePublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "absolute", must be one of ["absolute", ] # noqa: E501 + _from (date): First day of the period, inclusive. + granularity (str): Date granularity of the period.. defaults to "GDC.time.date", must be one of ["GDC.time.date", ] # noqa: E501 + to (date): Last day of the period, inclusive. + _check_type (bool): 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', "absolute") + granularity = kwargs.get('granularity', "GDC.time.date") + _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': [ + AbsolutePublisherDocumentPeriodAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period_all_of.py b/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period_all_of.py new file mode 100644 index 000000000..aacd3223d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/absolute_publisher_document_period_all_of.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 + + + +class AbsolutePublisherDocumentPeriodAllOf(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',): { + 'GDC.TIME.DATE': "GDC.time.date", + }, + ('type',): { + 'ABSOLUTE': "absolute", + }, + } + + 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 { + '_from': (date,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (date,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + '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 + """AbsolutePublisherDocumentPeriodAllOf - 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 (date): First day of the period, inclusive.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] if omitted the server will use the default value of "GDC.time.date" # noqa: E501 + to (date): Last day of the period, inclusive.. [optional] # noqa: E501 + type (str): Type of the period.. [optional] if omitted the server will use the default value of "absolute" # 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 + """AbsolutePublisherDocumentPeriodAllOf - 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 (date): First day of the period, inclusive.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] if omitted the server will use the default value of "GDC.time.date" # noqa: E501 + to (date): Last day of the period, inclusive.. [optional] # noqa: E501 + type (str): Type of the period.. [optional] if omitted the server will use the default value of "absolute" # 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/analyze_sav_request.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request.py new file mode 100644 index 000000000..f8e27adef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request.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.analyze_sav_request_item import AnalyzeSavRequestItem + globals()['AnalyzeSavRequestItem'] = AnalyzeSavRequestItem + + +class AnalyzeSavRequest(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 { + 'analyze_requests': ([AnalyzeSavRequestItem],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'analyze_requests': 'analyzeRequests', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, analyze_requests, *args, **kwargs): # noqa: E501 + """AnalyzeSavRequest - a model defined in OpenAPI + + Args: + analyze_requests ([AnalyzeSavRequestItem]): List of individual SPSS file analysis requests. + + 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.analyze_requests = analyze_requests + 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, analyze_requests, *args, **kwargs): # noqa: E501 + """AnalyzeSavRequest - a model defined in OpenAPI + + Args: + analyze_requests ([AnalyzeSavRequestItem]): List of individual SPSS file analysis requests. + + 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.analyze_requests = analyze_requests + 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/analyze_sav_request_item.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request_item.py new file mode 100644 index 000000000..c86b05e5b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request_item.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 + + +def lazy_import(): + from gooddata_api_client.model.analyze_sav_request_item_config import AnalyzeSavRequestItemConfig + globals()['AnalyzeSavRequestItemConfig'] = AnalyzeSavRequestItemConfig + + +class AnalyzeSavRequestItem(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 { + 'location': (str,), # noqa: E501 + 'config': (AnalyzeSavRequestItemConfig,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'location': 'location', # noqa: E501 + 'config': 'config', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, location, *args, **kwargs): # noqa: E501 + """AnalyzeSavRequestItem - a model defined in OpenAPI + + Args: + location (str): Location of the SPSS file to analyze. + + 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,) + config (AnalyzeSavRequestItemConfig): [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.location = location + 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, location, *args, **kwargs): # noqa: E501 + """AnalyzeSavRequestItem - a model defined in OpenAPI + + Args: + location (str): Location of the SPSS file to analyze. + + 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,) + config (AnalyzeSavRequestItemConfig): [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.location = location + 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/analyze_sav_request_item_config.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request_item_config.py new file mode 100644 index 000000000..322f1bc58 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_request_item_config.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 AnalyzeSavRequestItemConfig(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 { + 'result_rows': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'result_rows': 'resultRows', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AnalyzeSavRequestItemConfig - 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,) + result_rows (int): Number of rows to return as the preview of the file. The default is 100, the maximum is 1000.. [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 + """AnalyzeSavRequestItemConfig - 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,) + result_rows (int): Number of rows to return as the preview of the file. The default is 100, the maximum is 1000.. [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/analyze_sav_response.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response.py new file mode 100644 index 000000000..090fc4b77 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.analyze_sav_response_column import AnalyzeSavResponseColumn + globals()['AnalyzeSavResponseColumn'] = AnalyzeSavResponseColumn + + +class AnalyzeSavResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'columns': ([AnalyzeSavResponseColumn],), # noqa: E501 + 'location': (str,), # noqa: E501 + 'preview_data': ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'columns': 'columns', # noqa: E501 + 'location': 'location', # noqa: E501 + 'preview_data': 'previewData', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, columns, location, preview_data, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponse - a model defined in OpenAPI + + Args: + columns ([AnalyzeSavResponseColumn]): List of column metadata. + location (str): Location of the analyzed file in the source data source. + preview_data ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]): Preview of the first N rows of the file. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.columns = columns + self.location = location + self.preview_data = preview_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, columns, location, preview_data, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponse - a model defined in OpenAPI + + Args: + columns ([AnalyzeSavResponseColumn]): List of column metadata. + location (str): Location of the analyzed file in the source data source. + preview_data ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]): Preview of the first N rows of the file. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.columns = columns + self.location = location + self.preview_data = preview_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/analyze_sav_response_column.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response_column.py new file mode 100644 index 000000000..2eff812bd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response_column.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.analyze_sav_response_value_label import AnalyzeSavResponseValueLabel + globals()['AnalyzeSavResponseValueLabel'] = AnalyzeSavResponseValueLabel + + +class AnalyzeSavResponseColumn(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 { + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + 'value_labels': ([AnalyzeSavResponseValueLabel],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'label': 'label', # noqa: E501 + 'value_labels': 'valueLabels', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponseColumn - a model defined in OpenAPI + + Args: + name (str): Name of the column as specified in the file. + type (str): Type of the column (e.g. string, float64, date32). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): Label of the column, in a survey file usually the question text. Null if there is none.. [optional] # noqa: E501 + value_labels ([AnalyzeSavResponseValueLabel]): Labels of the column values in file order. Null if there are none.. [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 + 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, name, type, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponseColumn - a model defined in OpenAPI + + Args: + name (str): Name of the column as specified in the file. + type (str): Type of the column (e.g. string, float64, date32). + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): Label of the column, in a survey file usually the question text. Null if there is none.. [optional] # noqa: E501 + value_labels ([AnalyzeSavResponseValueLabel]): Labels of the column values in file order. Null if there are none.. [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 + 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/analyze_sav_response_value_label.py b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response_value_label.py new file mode 100644 index 000000000..7fa1faed6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/analyze_sav_response_value_label.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class AnalyzeSavResponseValueLabel(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 { + 'label': (str,), # noqa: E501 + 'value': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'label': 'label', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, label, value, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponseValueLabel - a model defined in OpenAPI + + Args: + label (str): The label of the value, in a survey file usually the answer text. + value ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The value: a number in a numeric column, a string in a string column. + + 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.label = label + 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, label, value, *args, **kwargs): # noqa: E501 + """AnalyzeSavResponseValueLabel - a model defined in OpenAPI + + Args: + label (str): The label of the value, in a survey file usually the answer text. + value ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The value: a number in a numeric column, a string in a string column. + + 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.label = label + 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/attribute_header_attribute_header.py b/gooddata-api-client/gooddata_api_client/model/attribute_header_attribute_header.py index 9968ba180..6de74fda0 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 @@ -64,6 +64,16 @@ class AttributeHeaderAttributeHeader(ModelNormal): """ allowed_values = { + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", + }, ('granularity',): { 'SECOND': "SECOND", 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", @@ -156,9 +166,11 @@ def openapi_types(): 'label_name': (str,), # noqa: E501 'local_identifier': (str,), # noqa: E501 'primary_label': (RestApiIdentifier,), # noqa: E501 + 'data_type': (str,), # noqa: E501 'format': (AttributeFormat,), # noqa: E501 'geo_area_config': (GeoAreaConfig,), # noqa: E501 'granularity': (str,), # noqa: E501 + 'number_format': (str,), # noqa: E501 'value_type': (str,), # noqa: E501 } @@ -174,9 +186,11 @@ def discriminator(): 'label_name': 'labelName', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 'primary_label': 'primaryLabel', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 'format': 'format', # noqa: E501 'geo_area_config': 'geoAreaConfig', # noqa: E501 'granularity': 'granularity', # noqa: E501 + 'number_format': 'numberFormat', # noqa: E501 'value_type': 'valueType', # noqa: E501 } @@ -229,9 +243,11 @@ def _from_openapi_data(cls, attribute, attribute_name, label, label_name, local_ Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + data_type (str): Data type of the attribute values, only filled for computed attributes.. [optional] # noqa: E501 format (AttributeFormat): [optional] # noqa: E501 geo_area_config (GeoAreaConfig): [optional] # noqa: E501 granularity (str): Date granularity of the attribute, only filled for date attributes.. [optional] # noqa: E501 + number_format (str): Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format.. [optional] # noqa: E501 value_type (str): Attribute value type.. [optional] # noqa: E501 """ @@ -332,9 +348,11 @@ def __init__(self, attribute, attribute_name, label, label_name, local_identifie Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + data_type (str): Data type of the attribute values, only filled for computed attributes.. [optional] # noqa: E501 format (AttributeFormat): [optional] # noqa: E501 geo_area_config (GeoAreaConfig): [optional] # noqa: E501 granularity (str): Date granularity of the attribute, only filled for date attributes.. [optional] # noqa: E501 + number_format (str): Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format.. [optional] # noqa: E501 value_type (str): Attribute value type.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_agent.py b/gooddata-api-client/gooddata_api_client/model/declarative_agent.py index c5116d302..aa6b415f3 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_agent.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_agent.py @@ -80,6 +80,7 @@ class DeclarativeAgent(ModelNormal): 'DASHBOARD_BUILDER': "dashboard_builder", 'DASHBOARD_EDITOR': "dashboard_editor", 'REPORT_BUILDER': "report_builder", + 'DOCUMENT_BUILDER': "document_builder", }, ('skills_mode',): { 'ALL': "all", diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py index 448bf1bc4..ba92f3be8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytical_dashboard.py @@ -221,7 +221,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 description (str): Analytical dashboard description.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions.. [optional] # noqa: E501 + permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions. A PUT without this property removes all existing permissions.. [optional] # noqa: E501 summary (str): AI-generated summary of the dashboard content. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ @@ -326,7 +326,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 description (str): Analytical dashboard description.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 - permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions.. [optional] # noqa: E501 + permissions ([DeclarativeAnalyticalDashboardPermissionsInner]): A list of permissions. A PUT without this property removes all existing permissions.. [optional] # noqa: E501 summary (str): AI-generated summary of the dashboard content. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py index 64b6317c5..53ecf55a0 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_analytics_layer.py @@ -41,6 +41,9 @@ def lazy_import(): from gooddata_api_client.model.declarative_memory_item import DeclarativeMemoryItem from gooddata_api_client.model.declarative_metric import DeclarativeMetric from gooddata_api_client.model.declarative_parameter import DeclarativeParameter + from gooddata_api_client.model.declarative_publisher_document import DeclarativePublisherDocument + from gooddata_api_client.model.declarative_publisher_document_page_template import DeclarativePublisherDocumentPageTemplate + from gooddata_api_client.model.declarative_publisher_document_template import DeclarativePublisherDocumentTemplate from gooddata_api_client.model.declarative_report import DeclarativeReport from gooddata_api_client.model.declarative_report_page_layout import DeclarativeReportPageLayout from gooddata_api_client.model.declarative_report_template import DeclarativeReportTemplate @@ -55,6 +58,9 @@ def lazy_import(): globals()['DeclarativeMemoryItem'] = DeclarativeMemoryItem globals()['DeclarativeMetric'] = DeclarativeMetric globals()['DeclarativeParameter'] = DeclarativeParameter + globals()['DeclarativePublisherDocument'] = DeclarativePublisherDocument + globals()['DeclarativePublisherDocumentPageTemplate'] = DeclarativePublisherDocumentPageTemplate + globals()['DeclarativePublisherDocumentTemplate'] = DeclarativePublisherDocumentTemplate globals()['DeclarativeReport'] = DeclarativeReport globals()['DeclarativeReportPageLayout'] = DeclarativeReportPageLayout globals()['DeclarativeReportTemplate'] = DeclarativeReportTemplate @@ -119,10 +125,13 @@ def openapi_types(): 'attribute_hierarchies': ([DeclarativeAttributeHierarchy],), # noqa: E501 'computed_attributes': ([DeclarativeComputedAttribute],), # noqa: E501 'dashboard_plugins': ([DeclarativeDashboardPlugin],), # noqa: E501 + 'document_templates': ([DeclarativePublisherDocumentTemplate],), # noqa: E501 + 'documents': ([DeclarativePublisherDocument],), # noqa: E501 'export_definitions': ([DeclarativeExportDefinition],), # noqa: E501 'filter_contexts': ([DeclarativeFilterContext],), # noqa: E501 'memory_items': ([DeclarativeMemoryItem],), # noqa: E501 'metrics': ([DeclarativeMetric],), # noqa: E501 + 'page_templates': ([DeclarativePublisherDocumentPageTemplate],), # noqa: E501 'parameters': ([DeclarativeParameter],), # noqa: E501 'report_page_layouts': ([DeclarativeReportPageLayout],), # noqa: E501 'report_templates': ([DeclarativeReportTemplate],), # noqa: E501 @@ -141,10 +150,13 @@ def discriminator(): 'attribute_hierarchies': 'attributeHierarchies', # noqa: E501 'computed_attributes': 'computedAttributes', # noqa: E501 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 + 'document_templates': 'documentTemplates', # noqa: E501 + 'documents': 'documents', # noqa: E501 'export_definitions': 'exportDefinitions', # noqa: E501 'filter_contexts': 'filterContexts', # noqa: E501 'memory_items': 'memoryItems', # noqa: E501 'metrics': 'metrics', # noqa: E501 + 'page_templates': 'pageTemplates', # noqa: E501 'parameters': 'parameters', # noqa: E501 'report_page_layouts': 'reportPageLayouts', # noqa: E501 'report_templates': 'reportTemplates', # noqa: E501 @@ -198,10 +210,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 attribute_hierarchies ([DeclarativeAttributeHierarchy]): A list of attribute hierarchies.. [optional] # noqa: E501 computed_attributes ([DeclarativeComputedAttribute]): A list of computed attributes available in the model.. [optional] # noqa: E501 dashboard_plugins ([DeclarativeDashboardPlugin]): A list of dashboard plugins available in the model.. [optional] # noqa: E501 + document_templates ([DeclarativePublisherDocumentTemplate]): A list of document templates available in the model.. [optional] # noqa: E501 + documents ([DeclarativePublisherDocument]): A list of documents available in the model.. [optional] # noqa: E501 export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 memory_items ([DeclarativeMemoryItem]): A list of AI memory items available in the workspace.. [optional] # noqa: E501 metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 + page_templates ([DeclarativePublisherDocumentPageTemplate]): A list of page templates available in the model.. [optional] # noqa: E501 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 @@ -297,10 +312,13 @@ def __init__(self, *args, **kwargs): # noqa: E501 attribute_hierarchies ([DeclarativeAttributeHierarchy]): A list of attribute hierarchies.. [optional] # noqa: E501 computed_attributes ([DeclarativeComputedAttribute]): A list of computed attributes available in the model.. [optional] # noqa: E501 dashboard_plugins ([DeclarativeDashboardPlugin]): A list of dashboard plugins available in the model.. [optional] # noqa: E501 + document_templates ([DeclarativePublisherDocumentTemplate]): A list of document templates available in the model.. [optional] # noqa: E501 + documents ([DeclarativePublisherDocument]): A list of documents available in the model.. [optional] # noqa: E501 export_definitions ([DeclarativeExportDefinition]): A list of export definitions.. [optional] # noqa: E501 filter_contexts ([DeclarativeFilterContext]): A list of filter contexts available in the model.. [optional] # noqa: E501 memory_items ([DeclarativeMemoryItem]): A list of AI memory items available in the workspace.. [optional] # noqa: E501 metrics ([DeclarativeMetric]): A list of metrics available in the model.. [optional] # noqa: E501 + page_templates ([DeclarativePublisherDocumentPageTemplate]): A list of page templates available in the model.. [optional] # noqa: E501 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_column.py b/gooddata-api-client/gooddata_api_client/model/declarative_column.py index 71c8293de..612ed3ca8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_column.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_column.py @@ -72,6 +72,9 @@ class DeclarativeColumn(ModelNormal): ('name',): { 'max_length': 255, }, + ('default_label_of',): { + 'max_length': 255, + }, ('description',): { 'max_length': 10000, }, @@ -106,6 +109,7 @@ def openapi_types(): return { 'data_type': (str,), # noqa: E501 'name': (str,), # noqa: E501 + 'default_label_of': (str,), # noqa: E501 'description': (str,), # noqa: E501 'is_nullable': (bool,), # noqa: E501 'is_primary_key': (bool,), # noqa: E501 @@ -122,6 +126,7 @@ def discriminator(): attribute_map = { 'data_type': 'dataType', # noqa: E501 'name': 'name', # noqa: E501 + 'default_label_of': 'defaultLabelOf', # noqa: E501 'description': 'description', # noqa: E501 'is_nullable': 'isNullable', # noqa: E501 'is_primary_key': 'isPrimaryKey', # noqa: E501 @@ -175,6 +180,7 @@ def _from_openapi_data(cls, data_type, name, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + default_label_of (str): (EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.. [optional] # noqa: E501 description (str): Column description/comment from database. [optional] # noqa: E501 is_nullable (bool): Column is nullable. [optional] # noqa: E501 is_primary_key (bool): Is column part of primary key?. [optional] # noqa: E501 @@ -272,6 +278,7 @@ def __init__(self, data_type, name, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + default_label_of (str): (EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.. [optional] # noqa: E501 description (str): Column description/comment from database. [optional] # noqa: E501 is_nullable (bool): Column is nullable. [optional] # noqa: E501 is_primary_key (bool): Is column part of primary key?. [optional] # noqa: E501 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 049070a32..bd43872d2 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 @@ -88,7 +88,6 @@ class DeclarativeDataSource(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", @@ -192,6 +191,7 @@ def openapi_types(): 'date_time_semantics': (str, none_type,), # noqa: E501 'decoded_parameters': ([Parameter],), # noqa: E501 'disable_statistics': (bool, none_type,), # noqa: E501 + 'ignore_jwt_aud': (bool, none_type,), # noqa: E501 'parameters': ([Parameter],), # noqa: E501 'password': (str,), # noqa: E501 'permissions': ([DeclarativeDataSourcePermission],), # noqa: E501 @@ -221,6 +221,7 @@ def discriminator(): 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'decoded_parameters': 'decodedParameters', # noqa: E501 'disable_statistics': 'disableStatistics', # noqa: E501 + 'ignore_jwt_aud': 'ignoreJwtAud', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 'permissions': 'permissions', # noqa: E501 @@ -287,6 +288,7 @@ def _from_openapi_data(cls, id, name, schema, type, *args, **kwargs): # noqa: E date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. - LOCAL: The values are assumed to be in local timezone and they are not converted to the user's timezone. - UTC: The values are assumed to be in UTC and they are converted to the user's timezone.. [optional] # noqa: E501 decoded_parameters ([Parameter]): [optional] # noqa: E501 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [optional] # noqa: E501 parameters ([Parameter]): [optional] # noqa: E501 password (str): Password for the data-source user, property is never returned back.. [optional] # noqa: E501 permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 @@ -399,6 +401,7 @@ def __init__(self, id, name, schema, type, *args, **kwargs): # noqa: E501 date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. - LOCAL: The values are assumed to be in local timezone and they are not converted to the user's timezone. - UTC: The values are assumed to be in UTC and they are converted to the user's timezone.. [optional] # noqa: E501 decoded_parameters ([Parameter]): [optional] # noqa: E501 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [optional] # noqa: E501 parameters ([Parameter]): [optional] # noqa: E501 password (str): Password for the data-source user, property is never returned back.. [optional] # noqa: E501 permissions ([DeclarativeDataSourcePermission]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric.py index 59635cf7d..9f088ee17 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.declarative_metric_permissions_inner import DeclarativeMetricPermissionsInner from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier from gooddata_api_client.model.json_node import JsonNode from gooddata_api_client.model.object_conditional_formatting import ObjectConditionalFormatting + globals()['DeclarativeMetricPermissionsInner'] = DeclarativeMetricPermissionsInner globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier globals()['JsonNode'] = JsonNode globals()['ObjectConditionalFormatting'] = ObjectConditionalFormatting @@ -138,6 +140,7 @@ def openapi_types(): 'is_hidden_from_kda': (bool,), # noqa: E501 'modified_at': (str, none_type,), # noqa: E501 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'permissions': ([DeclarativeMetricPermissionsInner], none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -162,6 +165,7 @@ def discriminator(): 'is_hidden_from_kda': 'isHiddenFromKda', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 'modified_by': 'modifiedBy', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 'tags': 'tags', # noqa: E501 } @@ -223,6 +227,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 is_hidden_from_kda (bool): If true, this metric is hidden from key drive analysis.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + permissions ([DeclarativeMetricPermissionsInner], none_type): A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ @@ -329,6 +334,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 is_hidden_from_kda (bool): If true, this metric is hidden from key drive analysis.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + permissions ([DeclarativeMetricPermissionsInner], none_type): A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_assignment.py new file mode 100644 index 000000000..0dfc036d8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_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 DeclarativeMetricPermissionAssignment(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 = { + ('name',): { + '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 = 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. + """ + return { + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """DeclarativeMetricPermissionAssignment - a model defined in OpenAPI + + Args: + name (str): Permission name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _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 + """DeclarativeMetricPermissionAssignment - a model defined in OpenAPI + + Args: + name (str): Permission name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_for_assignee.py new file mode 100644 index 000000000..c2eef6a9d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_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.declarative_analytical_dashboard_permission_for_assignee_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf + from gooddata_api_client.model.declarative_metric_permission_assignment import DeclarativeMetricPermissionAssignment + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf + globals()['DeclarativeMetricPermissionAssignment'] = DeclarativeMetricPermissionAssignment + + +class DeclarativeMetricPermissionForAssignee(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee': (AssigneeIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'assignee': 'assignee', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeclarativeMetricPermissionForAssignee - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + assignee (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 + """DeclarativeMetricPermissionForAssignee - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + assignee (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': [ + DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf, + DeclarativeMetricPermissionAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_for_assignee_rule.py new file mode 100644 index 000000000..b05d45eb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permission_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.attribute_permissions_for_assignee_rule_all_of import AttributePermissionsForAssigneeRuleAllOf + from gooddata_api_client.model.declarative_metric_permission_assignment import DeclarativeMetricPermissionAssignment + globals()['AssigneeRule'] = AssigneeRule + globals()['AttributePermissionsForAssigneeRuleAllOf'] = AttributePermissionsForAssigneeRuleAllOf + globals()['DeclarativeMetricPermissionAssignment'] = DeclarativeMetricPermissionAssignment + + +class DeclarativeMetricPermissionForAssigneeRule(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # 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 + """DeclarativeMetricPermissionForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + 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 + """DeclarativeMetricPermissionForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + 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': [ + AttributePermissionsForAssigneeRuleAllOf, + DeclarativeMetricPermissionAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_metric_permissions_inner.py b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permissions_inner.py new file mode 100644 index 000000000..93f5f596e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric_permissions_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.declarative_metric_permission_for_assignee import DeclarativeMetricPermissionForAssignee + from gooddata_api_client.model.declarative_metric_permission_for_assignee_rule import DeclarativeMetricPermissionForAssigneeRule + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AssigneeRule'] = AssigneeRule + globals()['DeclarativeMetricPermissionForAssignee'] = DeclarativeMetricPermissionForAssignee + globals()['DeclarativeMetricPermissionForAssigneeRule'] = DeclarativeMetricPermissionForAssigneeRule + + +class DeclarativeMetricPermissionsInner(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee': (AssigneeIdentifier,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'assignee': 'assignee', # 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 + """DeclarativeMetricPermissionsInner - 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,) + name (str): Permission name.. [optional] # noqa: E501 + assignee (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 + """DeclarativeMetricPermissionsInner - 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,) + name (str): Permission name.. [optional] # noqa: E501 + assignee (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': [ + DeclarativeMetricPermissionForAssignee, + DeclarativeMetricPermissionForAssigneeRule, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document.py b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document.py new file mode 100644 index 000000000..e46150be6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document.py @@ -0,0 +1,323 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_content import PublisherDocumentContent + from gooddata_api_client.model.publisher_document_period import PublisherDocumentPeriod + globals()['PublisherDocumentContent'] = PublisherDocumentContent + globals()['PublisherDocumentPeriod'] = PublisherDocumentPeriod + + +class DeclarativePublisherDocument(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('tags',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'content': (PublisherDocumentContent,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'period': (PublisherDocumentPeriod,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'period': 'period', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, id, period, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocument - a model defined in OpenAPI + + Args: + content (PublisherDocumentContent): + id (str): Document ID. + period (PublisherDocumentPeriod): + title (str): Document title. + version (str): Version of the content format. + + 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): Document description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.period = period + self.title = title + 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, content, id, period, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocument - a model defined in OpenAPI + + Args: + content (PublisherDocumentContent): + id (str): Document ID. + period (PublisherDocumentPeriod): + title (str): Document title. + version (str): Version of the content format. + + 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): Document description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.period = period + self.title = title + 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/declarative_publisher_document_page_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py new file mode 100644 index 000000000..39ec27214 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_page_template.py @@ -0,0 +1,315 @@ +""" + 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.publisher_document_page_template_content import PublisherDocumentPageTemplateContent + globals()['PublisherDocumentPageTemplateContent'] = PublisherDocumentPageTemplateContent + + +class DeclarativePublisherDocumentPageTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('tags',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'content': (PublisherDocumentPageTemplateContent,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, id, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocumentPageTemplate - a model defined in OpenAPI + + Args: + content (PublisherDocumentPageTemplateContent): + id (str): Page template ID. + title (str): Page template title. + version (str): Version of the content format. + + 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): Page template description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.title = title + 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, content, id, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocumentPageTemplate - a model defined in OpenAPI + + Args: + content (PublisherDocumentPageTemplateContent): + id (str): Page template ID. + title (str): Page template title. + version (str): Version of the content format. + + 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): Page template description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.title = title + 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/declarative_publisher_document_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py new file mode 100644 index 000000000..eb0082a2f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_publisher_document_template.py @@ -0,0 +1,315 @@ +""" + 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.publisher_document_content import PublisherDocumentContent + globals()['PublisherDocumentContent'] = PublisherDocumentContent + + +class DeclarativePublisherDocumentTemplate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('tags',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'content': (PublisherDocumentContent,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, id, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocumentTemplate - a model defined in OpenAPI + + Args: + content (PublisherDocumentContent): + id (str): Document template ID. + title (str): Document template title. + version (str): Version of the content format. + + 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): Document template description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.title = title + 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, content, id, title, version, *args, **kwargs): # noqa: E501 + """DeclarativePublisherDocumentTemplate - a model defined in OpenAPI + + Args: + content (PublisherDocumentContent): + id (str): Document template ID. + title (str): Document template title. + version (str): Version of the content format. + + 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): Document template description.. [optional] # noqa: E501 + tags ([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.content = content + self.id = id + self.title = title + 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/declarative_table.py b/gooddata-api-client/gooddata_api_client/model/declarative_table.py index 20f8c9b14..05dadd4f8 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_table.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_table.py @@ -101,6 +101,7 @@ def openapi_types(): 'path': ([str],), # noqa: E501 'type': (str,), # noqa: E501 'name_prefix': (str,), # noqa: E501 + 'properties': ({str: (str,)},), # noqa: E501 } @cached_property @@ -114,6 +115,7 @@ def discriminator(): 'path': 'path', # noqa: E501 'type': 'type', # noqa: E501 'name_prefix': 'namePrefix', # noqa: E501 + 'properties': 'properties', # noqa: E501 } read_only_vars = { @@ -164,6 +166,7 @@ def _from_openapi_data(cls, columns, id, path, type, *args, **kwargs): # noqa: through its discriminator because we passed in _visited_composed_classes = (Animal,) name_prefix (str): Table or view name prefix used in scan. Will be stripped when generating LDM.. [optional] # noqa: E501 + properties ({str: (str,)}): Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -260,6 +263,7 @@ def __init__(self, columns, id, path, type, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) name_prefix (str): Table or view name prefix used in scan. Will be stripped when generating LDM.. [optional] # noqa: E501 + properties ({str: (str,)}): Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py index 10a321dec..2eb76952d 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object.py @@ -33,9 +33,11 @@ def lazy_import(): from gooddata_api_client.model.conditional_formatting import ConditionalFormatting from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier + from gooddata_api_client.model.declarative_visualization_object_permissions_inner import DeclarativeVisualizationObjectPermissionsInner from gooddata_api_client.model.json_node import JsonNode globals()['ConditionalFormatting'] = ConditionalFormatting globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + globals()['DeclarativeVisualizationObjectPermissionsInner'] = DeclarativeVisualizationObjectPermissionsInner globals()['JsonNode'] = JsonNode @@ -137,6 +139,7 @@ def openapi_types(): 'is_hidden': (bool,), # noqa: E501 'modified_at': (str, none_type,), # noqa: E501 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'permissions': ([DeclarativeVisualizationObjectPermissionsInner], none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -160,6 +163,7 @@ def discriminator(): 'is_hidden': 'isHidden', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 'modified_by': 'modifiedBy', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 'tags': 'tags', # noqa: E501 } @@ -220,6 +224,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 is_hidden (bool): If true, this visualization object is hidden from AI search results.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + permissions ([DeclarativeVisualizationObjectPermissionsInner], none_type): A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ @@ -325,6 +330,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 is_hidden (bool): If true, this visualization object is hidden from AI search results.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + permissions ([DeclarativeVisualizationObjectPermissionsInner], none_type): A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_assignment.py new file mode 100644 index 000000000..ed9357113 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_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 DeclarativeVisualizationObjectPermissionAssignment(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 = { + ('name',): { + '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 = 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. + """ + return { + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """DeclarativeVisualizationObjectPermissionAssignment - a model defined in OpenAPI + + Args: + name (str): Permission name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _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 + """DeclarativeVisualizationObjectPermissionAssignment - a model defined in OpenAPI + + Args: + name (str): Permission name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_for_assignee.py new file mode 100644 index 000000000..859a75263 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_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.declarative_analytical_dashboard_permission_for_assignee_all_of import DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf + from gooddata_api_client.model.declarative_visualization_object_permission_assignment import DeclarativeVisualizationObjectPermissionAssignment + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf'] = DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf + globals()['DeclarativeVisualizationObjectPermissionAssignment'] = DeclarativeVisualizationObjectPermissionAssignment + + +class DeclarativeVisualizationObjectPermissionForAssignee(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee': (AssigneeIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'assignee': 'assignee', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DeclarativeVisualizationObjectPermissionForAssignee - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + assignee (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 + """DeclarativeVisualizationObjectPermissionForAssignee - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + assignee (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': [ + DeclarativeAnalyticalDashboardPermissionForAssigneeAllOf, + DeclarativeVisualizationObjectPermissionAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_for_assignee_rule.py new file mode 100644 index 000000000..3d876a449 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permission_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.attribute_permissions_for_assignee_rule_all_of import AttributePermissionsForAssigneeRuleAllOf + from gooddata_api_client.model.declarative_visualization_object_permission_assignment import DeclarativeVisualizationObjectPermissionAssignment + globals()['AssigneeRule'] = AssigneeRule + globals()['AttributePermissionsForAssigneeRuleAllOf'] = AttributePermissionsForAssigneeRuleAllOf + globals()['DeclarativeVisualizationObjectPermissionAssignment'] = DeclarativeVisualizationObjectPermissionAssignment + + +class DeclarativeVisualizationObjectPermissionForAssigneeRule(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # 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 + """DeclarativeVisualizationObjectPermissionForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + 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 + """DeclarativeVisualizationObjectPermissionForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + name (str): Permission name. + 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': [ + AttributePermissionsForAssigneeRuleAllOf, + DeclarativeVisualizationObjectPermissionAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permissions_inner.py b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permissions_inner.py new file mode 100644 index 000000000..7e15399ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_visualization_object_permissions_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.declarative_visualization_object_permission_for_assignee import DeclarativeVisualizationObjectPermissionForAssignee + from gooddata_api_client.model.declarative_visualization_object_permission_for_assignee_rule import DeclarativeVisualizationObjectPermissionForAssigneeRule + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AssigneeRule'] = AssigneeRule + globals()['DeclarativeVisualizationObjectPermissionForAssignee'] = DeclarativeVisualizationObjectPermissionForAssignee + globals()['DeclarativeVisualizationObjectPermissionForAssigneeRule'] = DeclarativeVisualizationObjectPermissionForAssigneeRule + + +class DeclarativeVisualizationObjectPermissionsInner(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 = { + ('name',): { + '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 { + 'name': (str,), # noqa: E501 + 'assignee': (AssigneeIdentifier,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'assignee': 'assignee', # 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 + """DeclarativeVisualizationObjectPermissionsInner - 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,) + name (str): Permission name.. [optional] # noqa: E501 + assignee (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 + """DeclarativeVisualizationObjectPermissionsInner - 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,) + name (str): Permission name.. [optional] # noqa: E501 + assignee (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': [ + DeclarativeVisualizationObjectPermissionForAssignee, + DeclarativeVisualizationObjectPermissionForAssigneeRule, + ], + } 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 789436833..da3d16fcf 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_response.py +++ b/gooddata-api-client/gooddata_api_client/model/elements_response.py @@ -66,6 +66,16 @@ class ElementsResponse(ModelNormal): """ allowed_values = { + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", + }, ('granularity',): { 'SECOND': "SECOND", 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", @@ -140,8 +150,10 @@ def openapi_types(): 'paging': (Paging,), # noqa: E501 'primary_label': (RestApiIdentifier,), # noqa: E501 'cache_id': (str,), # noqa: E501 + 'data_type': (str,), # noqa: E501 'format': (AttributeFormat,), # noqa: E501 'granularity': (str,), # noqa: E501 + 'number_format': (str,), # noqa: E501 } @cached_property @@ -154,8 +166,10 @@ def discriminator(): 'paging': 'paging', # noqa: E501 'primary_label': 'primaryLabel', # noqa: E501 'cache_id': 'cacheId', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 'format': 'format', # noqa: E501 'granularity': 'granularity', # noqa: E501 + 'number_format': 'numberFormat', # noqa: E501 } read_only_vars = { @@ -205,8 +219,10 @@ def _from_openapi_data(cls, elements, paging, primary_label, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) cache_id (str): The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.. [optional] # noqa: E501 + data_type (str): Data type of the element values, only filled for computed attributes.. [optional] # noqa: E501 format (AttributeFormat): [optional] # noqa: E501 granularity (str): Granularity of requested label in case of date attribute. [optional] # noqa: E501 + number_format (str): Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -301,8 +317,10 @@ def __init__(self, elements, paging, primary_label, *args, **kwargs): # noqa: E through its discriminator because we passed in _visited_composed_classes = (Animal,) cache_id (str): The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.. [optional] # noqa: E501 + data_type (str): Data type of the element values, only filled for computed attributes.. [optional] # noqa: E501 format (AttributeFormat): [optional] # noqa: E501 granularity (str): Granularity of requested label in case of date attribute. [optional] # noqa: E501 + number_format (str): Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/gd_storage_file.py b/gooddata-api-client/gooddata_api_client/model/gd_storage_file.py index d10290bb1..5404c71fa 100644 --- a/gooddata-api-client/gooddata_api_client/model/gd_storage_file.py +++ b/gooddata-api-client/gooddata_api_client/model/gd_storage_file.py @@ -58,6 +58,7 @@ class GdStorageFile(ModelNormal): allowed_values = { ('type',): { 'CSV': "CSV", + 'SAV': "SAV", }, } @@ -110,16 +111,16 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, modified_at, name, size, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, modified_at, name, size, type, *args, **kwargs): # noqa: E501 """GdStorageFile - a model defined in OpenAPI Args: modified_at (datetime): Last modification timestamp of the file. name (str): Name of the file. size (int): Size of the file in bytes. + type (str): Type of the file. Keyword Args: - type (str): Type of the file.. defaults to "CSV", must be one of ["CSV", ] # 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. @@ -152,7 +153,6 @@ def _from_openapi_data(cls, modified_at, name, size, *args, **kwargs): # noqa: _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "CSV") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -206,16 +206,16 @@ def _from_openapi_data(cls, modified_at, name, size, *args, **kwargs): # noqa: ]) @convert_js_args_to_python_args - def __init__(self, modified_at, name, size, *args, **kwargs): # noqa: E501 + def __init__(self, modified_at, name, size, type, *args, **kwargs): # noqa: E501 """GdStorageFile - a model defined in OpenAPI Args: modified_at (datetime): Last modification timestamp of the file. name (str): Name of the file. size (int): Size of the file in bytes. + type (str): Type of the file. Keyword Args: - type (str): Type of the file.. defaults to "CSV", must be one of ["CSV", ] # 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,7 +248,6 @@ def __init__(self, modified_at, name, size, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "CSV") _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/get_image_export202_response_inner.py b/gooddata-api-client/gooddata_api_client/model/get_document_export202_response_inner.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/get_image_export202_response_inner.py rename to gooddata-api-client/gooddata_api_client/model/get_document_export202_response_inner.py index b8471bc53..66cfe8302 100644 --- a/gooddata-api-client/gooddata_api_client/model/get_image_export202_response_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/get_document_export202_response_inner.py @@ -31,7 +31,7 @@ -class GetImageExport202ResponseInner(ModelNormal): +class GetDocumentExport202ResponseInner(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -116,7 +116,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """GetImageExport202ResponseInner - a model defined in OpenAPI + """GetDocumentExport202ResponseInner - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -209,7 +209,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """GetImageExport202ResponseInner - a model defined in OpenAPI + """GetDocumentExport202ResponseInner - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types 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 6126167df..3d7ebc5e9 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 @@ -85,6 +85,9 @@ class IdentifierRefIdentifier(ModelNormal): 'REPORTPAGELAYOUT': "reportPageLayout", 'REPORTTEMPLATE': "reportTemplate", 'REPORT': "report", + 'PAGETEMPLATE': "pageTemplate", + 'DOCUMENT': "document", + 'DOCUMENTTEMPLATE': "documentTemplate", 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", 'WORKSPACETHEME': "workspaceTheme", 'WORKSPACECOLORPALETTE': "workspaceColorPalette", diff --git a/gooddata-api-client/gooddata_api_client/model/import_sav_request.py b/gooddata-api-client/gooddata_api_client/model/import_sav_request.py new file mode 100644 index 000000000..cd2ad5249 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/import_sav_request.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.import_sav_request_table import ImportSavRequestTable + globals()['ImportSavRequestTable'] = ImportSavRequestTable + + +class ImportSavRequest(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 { + 'tables': ([ImportSavRequestTable],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'tables': 'tables', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, tables, *args, **kwargs): # noqa: E501 + """ImportSavRequest - a model defined in OpenAPI + + Args: + tables ([ImportSavRequestTable]): Information about the individual tables. + + 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.tables = tables + 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, tables, *args, **kwargs): # noqa: E501 + """ImportSavRequest - a model defined in OpenAPI + + Args: + tables ([ImportSavRequestTable]): Information about the individual tables. + + 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.tables = tables + 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/import_sav_request_table.py b/gooddata-api-client/gooddata_api_client/model/import_sav_request_table.py new file mode 100644 index 000000000..c7e5e965d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/import_sav_request_table.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.import_sav_request_table_source import ImportSavRequestTableSource + globals()['ImportSavRequestTableSource'] = ImportSavRequestTableSource + + +class ImportSavRequestTable(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 { + 'name': (str,), # noqa: E501 + 'source': (ImportSavRequestTableSource,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'source': 'source', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, source, *args, **kwargs): # noqa: E501 + """ImportSavRequestTable - a model defined in OpenAPI + + Args: + name (str): Name of the table. + source (ImportSavRequestTableSource): + + 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.name = name + self.source = source + 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, source, *args, **kwargs): # noqa: E501 + """ImportSavRequestTable - a model defined in OpenAPI + + Args: + name (str): Name of the table. + source (ImportSavRequestTableSource): + + 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.name = name + self.source = source + 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/import_sav_request_table_source.py b/gooddata-api-client/gooddata_api_client/model/import_sav_request_table_source.py new file mode 100644 index 000000000..cd9a10cab --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/import_sav_request_table_source.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ImportSavRequestTableSource(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 { + 'location': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'location': 'location', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, location, *args, **kwargs): # noqa: E501 + """ImportSavRequestTableSource - a model defined in OpenAPI + + Args: + location (str): Location of the data in the staging area. + + 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.location = location + 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, location, *args, **kwargs): # noqa: E501 + """ImportSavRequestTableSource - a model defined in OpenAPI + + Args: + location (str): Location of the data in the staging area. + + 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.location = location + 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/import_sav_response.py b/gooddata-api-client/gooddata_api_client/model/import_sav_response.py new file mode 100644 index 000000000..63e43b3d6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/import_sav_response.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class ImportSavResponse(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 { + 'name': (str,), # noqa: E501 + 'version': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, version, *args, **kwargs): # noqa: E501 + """ImportSavResponse - a model defined in OpenAPI + + Args: + name (str): Name of the table the file was imported to. + version (int): Version the file was imported as. + + 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.name = name + 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, name, version, *args, **kwargs): # noqa: E501 + """ImportSavResponse - a model defined in OpenAPI + + Args: + name (str): Name of the table the file was imported to. + version (int): Version the file was imported as. + + 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.name = name + 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/json_api_agent_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes.py index 9251d4dfc..f6ef1c062 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes.py @@ -77,6 +77,7 @@ class JsonApiAgentInAttributes(ModelNormal): 'DASHBOARD_BUILDER': "dashboard_builder", 'DASHBOARD_EDITOR': "dashboard_editor", 'REPORT_BUILDER': "report_builder", + 'DOCUMENT_BUILDER': "document_builder", }, ('skills_mode',): { 'ALL': "all", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py index 314cb5738..b1892568f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py @@ -77,6 +77,7 @@ class JsonApiAgentOutAttributes(ModelNormal): 'DASHBOARD_BUILDER': "dashboard_builder", 'DASHBOARD_EDITOR': "dashboard_editor", 'REPORT_BUILDER': "report_builder", + 'DOCUMENT_BUILDER': "document_builder", }, ('skills_mode',): { 'ALL': "all", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py index 04783c753..222be3079 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py @@ -80,7 +80,6 @@ class JsonApiDataSourceIdentifierOutAttributes(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", 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 d5198e8c5..bb2bd68da 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 @@ -86,7 +86,6 @@ class JsonApiDataSourceInAttributes(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", @@ -184,6 +183,7 @@ def openapi_types(): 'client_secret': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 'disable_statistics': (bool, none_type,), # noqa: E501 + 'ignore_jwt_aud': (bool, none_type,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'password': (str, none_type,), # noqa: E501 'private_key': (str, none_type,), # noqa: E501 @@ -210,6 +210,7 @@ def discriminator(): 'client_secret': 'clientSecret', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'disable_statistics': 'disableStatistics', # noqa: E501 + 'ignore_jwt_aud': 'ignoreJwtAud', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 'private_key': 'privateKey', # noqa: E501 @@ -273,6 +274,7 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # 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 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [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 password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 private_key (str, none_type): The private key to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 @@ -381,6 +383,7 @@ def __init__(self, name, schema, type, *args, **kwargs): # 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 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [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 password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 private_key (str, none_type): The private key 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_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py index f152172fb..10b292d10 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 @@ -86,7 +86,6 @@ class JsonApiDataSourceOutAttributes(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", @@ -169,6 +168,7 @@ def openapi_types(): 'date_time_semantics': (str, none_type,), # noqa: E501 'decoded_parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'disable_statistics': (bool, none_type,), # noqa: E501 + 'ignore_jwt_aud': (bool, none_type,), # noqa: E501 'managed': (bool,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'url': (str, none_type,), # noqa: E501 @@ -192,6 +192,7 @@ def discriminator(): 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'decoded_parameters': 'decodedParameters', # noqa: E501 'disable_statistics': 'disableStatistics', # noqa: E501 + 'ignore_jwt_aud': 'ignoreJwtAud', # noqa: E501 'managed': 'managed', # noqa: E501 'parameters': 'parameters', # noqa: E501 'url': 'url', # noqa: E501 @@ -252,6 +253,7 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [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 @@ -357,6 +359,7 @@ def __init__(self, name, schema, type, *args, **kwargs): # 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [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 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 04fd529da..d7ead6aad 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 @@ -104,7 +104,6 @@ class JsonApiDataSourcePatchAttributes(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", @@ -181,6 +180,7 @@ def openapi_types(): 'client_secret': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 'disable_statistics': (bool, none_type,), # noqa: E501 + 'ignore_jwt_aud': (bool, none_type,), # noqa: E501 'name': (str,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'password': (str, none_type,), # noqa: E501 @@ -207,6 +207,7 @@ def discriminator(): 'client_secret': 'clientSecret', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'disable_statistics': 'disableStatistics', # noqa: E501 + 'ignore_jwt_aud': 'ignoreJwtAud', # noqa: E501 'name': 'name', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 @@ -268,6 +269,7 @@ def _from_openapi_data(cls, *args, **kwargs): # 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 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [optional] # noqa: E501 name (str): User-facing name of the data source.. [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 password (str, none_type): The password to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 @@ -371,6 +373,7 @@ def __init__(self, *args, **kwargs): # 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 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 disable_statistics (bool, none_type): Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.. [optional] # noqa: E501 + ignore_jwt_aud (bool, none_type): Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.. [optional] # noqa: E501 name (str): User-facing name of the data source.. [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 password (str, none_type): The password 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_publisher_document_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in.py new file mode 100644 index 000000000..b23584e06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_in_attributes import JsonApiPublisherDocumentInAttributes + globals()['JsonApiPublisherDocumentInAttributes'] = JsonApiPublisherDocumentInAttributes + + +class JsonApiPublisherDocumentIn(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',): { + 'DOCUMENT': "document", + }, + } + + 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': (JsonApiPublisherDocumentInAttributes,), # 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 + """JsonApiPublisherDocumentIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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 + """JsonApiPublisherDocumentIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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_publisher_document_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes.py new file mode 100644 index 000000000..0fae6b942 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes.py @@ -0,0 +1,314 @@ +""" + 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_publisher_document_in_attributes_content import JsonApiPublisherDocumentInAttributesContent + from gooddata_api_client.model.json_api_publisher_document_in_attributes_period import JsonApiPublisherDocumentInAttributesPeriod + globals()['JsonApiPublisherDocumentInAttributesContent'] = JsonApiPublisherDocumentInAttributesContent + globals()['JsonApiPublisherDocumentInAttributesPeriod'] = JsonApiPublisherDocumentInAttributesPeriod + + +class JsonApiPublisherDocumentInAttributes(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 = { + ('title',): { + '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 { + 'content': (JsonApiPublisherDocumentInAttributesContent,), # noqa: E501 + 'period': (JsonApiPublisherDocumentInAttributesPeriod,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'period': 'period', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, period, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentInAttributesContent): + period (JsonApiPublisherDocumentInAttributesPeriod): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.period = period + self.title = title + 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, content, period, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentInAttributesContent): + period (JsonApiPublisherDocumentInAttributesPeriod): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.period = period + self.title = title + 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/json_api_publisher_document_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes_content.py new file mode 100644 index 000000000..e6cf0bccb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes_content.py @@ -0,0 +1,308 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_area_style import PublisherDocumentAreaStyle + from gooddata_api_client.model.publisher_document_attribute_filter_config import PublisherDocumentAttributeFilterConfig + from gooddata_api_client.model.publisher_document_defaults import PublisherDocumentDefaults + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_page import PublisherDocumentPage + from gooddata_api_client.model.publisher_document_section import PublisherDocumentSection + globals()['PublisherDocumentAreaStyle'] = PublisherDocumentAreaStyle + globals()['PublisherDocumentAttributeFilterConfig'] = PublisherDocumentAttributeFilterConfig + globals()['PublisherDocumentDefaults'] = PublisherDocumentDefaults + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentPage'] = PublisherDocumentPage + globals()['PublisherDocumentSection'] = PublisherDocumentSection + + +class JsonApiPublisherDocumentInAttributesContent(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 { + 'attribute_filter_configs': ([PublisherDocumentAttributeFilterConfig],), # noqa: E501 + 'defaults': (PublisherDocumentDefaults,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'format_locale': (str,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'pages': ([PublisherDocumentPage],), # noqa: E501 + 'sections': ([PublisherDocumentSection],), # noqa: E501 + 'style': (PublisherDocumentAreaStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_filter_configs': 'attributeFilterConfigs', # noqa: E501 + 'defaults': 'defaults', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'format_locale': 'formatLocale', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'pages': 'pages', # noqa: E501 + 'sections': 'sections', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentInAttributesContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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 + """JsonApiPublisherDocumentInAttributesContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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_publisher_document_in_attributes_period.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes_period.py new file mode 100644 index 000000000..958ac98ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_attributes_period.py @@ -0,0 +1,361 @@ +""" + 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_publisher_document_period import AbsolutePublisherDocumentPeriod + from gooddata_api_client.model.relative_publisher_document_period import RelativePublisherDocumentPeriod + globals()['AbsolutePublisherDocumentPeriod'] = AbsolutePublisherDocumentPeriod + globals()['RelativePublisherDocumentPeriod'] = RelativePublisherDocumentPeriod + + +class JsonApiPublisherDocumentInAttributesPeriod(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',): { + 'RELATIVE': "relative", + }, + ('granularity',): { + 'SECOND': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + } + + 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 + '_from': (int,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'AbsolutePublisherDocumentPeriod': AbsolutePublisherDocumentPeriod, + 'RelativePublisherDocumentPeriod': RelativePublisherDocumentPeriod, + 'absolute': AbsolutePublisherDocumentPeriod, + 'relative': RelativePublisherDocumentPeriod, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'type': 'type', # noqa: E501 + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentInAttributesPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): Type of the period.. defaults to "relative", must be one of ["relative", ] # 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,) + _from (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "relative") + _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 + """JsonApiPublisherDocumentInAttributesPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): Type of the period.. defaults to "relative", must be one of ["relative", ] # 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,) + _from (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "relative") + _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': [ + AbsolutePublisherDocumentPeriod, + RelativePublisherDocumentPeriod, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_in_document.py new file mode 100644 index 000000000..b53ebe03c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_in import JsonApiPublisherDocumentIn + globals()['JsonApiPublisherDocumentIn'] = JsonApiPublisherDocumentIn + + +class JsonApiPublisherDocumentInDocument(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': (JsonApiPublisherDocumentIn,), # 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 + """JsonApiPublisherDocumentInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentIn): + + 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 + """JsonApiPublisherDocumentInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentIn): + + 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_publisher_document_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out.py new file mode 100644 index 000000000..a3bd9b683 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out.py @@ -0,0 +1,310 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_out_attributes import JsonApiPublisherDocumentOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentOutAttributes'] = JsonApiPublisherDocumentOutAttributes + + +class JsonApiPublisherDocumentOut(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',): { + 'DOCUMENT': "document", + }, + } + + 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': (JsonApiPublisherDocumentOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "document") + _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 + """JsonApiPublisherDocumentOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "document") + _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_publisher_document_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_attributes.py new file mode 100644 index 000000000..fe62c9571 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_attributes.py @@ -0,0 +1,332 @@ +""" + 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_publisher_document_in_attributes_content import JsonApiPublisherDocumentInAttributesContent + from gooddata_api_client.model.json_api_publisher_document_in_attributes_period import JsonApiPublisherDocumentInAttributesPeriod + globals()['JsonApiPublisherDocumentInAttributesContent'] = JsonApiPublisherDocumentInAttributesContent + globals()['JsonApiPublisherDocumentInAttributesPeriod'] = JsonApiPublisherDocumentInAttributesPeriod + + +class JsonApiPublisherDocumentOutAttributes(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 = { + ('title',): { + 'max_length': 255, + }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('description',): { + 'max_length': 10000, + }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + } + + @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': (JsonApiPublisherDocumentInAttributesContent,), # noqa: E501 + 'period': (JsonApiPublisherDocumentInAttributesPeriod,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'period': 'period', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'description': 'description', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, period, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentInAttributesContent): + period (JsonApiPublisherDocumentInAttributesPeriod): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.period = period + self.title = title + 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, content, period, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentInAttributesContent): + period (JsonApiPublisherDocumentInAttributesPeriod): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.period = period + self.title = title + 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/json_api_publisher_document_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_document.py new file mode 100644 index 000000000..206c79bb5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_document.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_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_publisher_document_out import JsonApiPublisherDocumentOut + from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiPublisherDocumentOut'] = JsonApiPublisherDocumentOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiPublisherDocumentOutDocument(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': (JsonApiPublisherDocumentOut,), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # 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 + """JsonApiPublisherDocumentOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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 + """JsonApiPublisherDocumentOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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_publisher_document_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_list.py new file mode 100644 index 000000000..640074553 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_out_with_links import JsonApiPublisherDocumentOutWithLinks + 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()['JsonApiPublisherDocumentOutWithLinks'] = JsonApiPublisherDocumentOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiPublisherDocumentOutList(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': ([JsonApiPublisherDocumentOutWithLinks],), # 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 + """JsonApiPublisherDocumentOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentOutWithLinks]): + + 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 + """JsonApiPublisherDocumentOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentOutWithLinks]): + + 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_publisher_document_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_with_links.py new file mode 100644 index 000000000..d920c40ec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_out_with_links.py @@ -0,0 +1,361 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_out import JsonApiPublisherDocumentOut + from gooddata_api_client.model.json_api_publisher_document_out_attributes import JsonApiPublisherDocumentOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentOut'] = JsonApiPublisherDocumentOut + globals()['JsonApiPublisherDocumentOutAttributes'] = JsonApiPublisherDocumentOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiPublisherDocumentOutWithLinks(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',): { + 'DOCUMENT': "document", + }, + } + + 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': (JsonApiPublisherDocumentOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "document", must be one of ["document", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "document") + _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 + """JsonApiPublisherDocumentOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "document", must be one of ["document", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "document") + _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': [ + JsonApiPublisherDocumentOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in.py new file mode 100644 index 000000000..556fdeab0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_in_attributes import JsonApiPublisherDocumentPageTemplateInAttributes + globals()['JsonApiPublisherDocumentPageTemplateInAttributes'] = JsonApiPublisherDocumentPageTemplateInAttributes + + +class JsonApiPublisherDocumentPageTemplateIn(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',): { + 'PAGETEMPLATE': "pageTemplate", + }, + } + + 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': (JsonApiPublisherDocumentPageTemplateInAttributes,), # 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 + """JsonApiPublisherDocumentPageTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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 + """JsonApiPublisherDocumentPageTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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_publisher_document_page_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes.py new file mode 100644 index 000000000..a8dde9826 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes.py @@ -0,0 +1,306 @@ +""" + 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_publisher_document_page_template_in_attributes_content import JsonApiPublisherDocumentPageTemplateInAttributesContent + globals()['JsonApiPublisherDocumentPageTemplateInAttributesContent'] = JsonApiPublisherDocumentPageTemplateInAttributesContent + + +class JsonApiPublisherDocumentPageTemplateInAttributes(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 = { + ('title',): { + '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 { + 'content': (JsonApiPublisherDocumentPageTemplateInAttributesContent,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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/json_api_publisher_document_page_template_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes_content.py new file mode 100644 index 000000000..7f35262ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in_attributes_content.py @@ -0,0 +1,308 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode + from gooddata_api_client.model.publisher_document_page_style import PublisherDocumentPageStyle + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentLayoutNode'] = PublisherDocumentLayoutNode + globals()['PublisherDocumentPageStyle'] = PublisherDocumentPageStyle + + +class JsonApiPublisherDocumentPageTemplateInAttributesContent(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 = { + ('kind',): { + 'COVER': "cover", + 'SECTION': "section", + 'CONTENT': "content", + }, + ('page_size',): { + 'WIDESCREEN': "widescreen", + }, + } + + 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 { + 'layout': (PublisherDocumentLayoutNode,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'notes': (str,), # noqa: E501 + 'page_size': (str,), # noqa: E501 + 'style': (PublisherDocumentPageStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'layout': 'layout', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'page_size': 'pageSize', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, layout, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateInAttributesContent - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [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.layout = layout + 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, layout, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateInAttributesContent - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [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.layout = layout + 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_publisher_document_page_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_in_document.py new file mode 100644 index 000000000..94354ee6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_in import JsonApiPublisherDocumentPageTemplateIn + globals()['JsonApiPublisherDocumentPageTemplateIn'] = JsonApiPublisherDocumentPageTemplateIn + + +class JsonApiPublisherDocumentPageTemplateInDocument(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': (JsonApiPublisherDocumentPageTemplateIn,), # 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 + """JsonApiPublisherDocumentPageTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplateIn): + + 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 + """JsonApiPublisherDocumentPageTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplateIn): + + 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_publisher_document_page_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out.py new file mode 100644 index 000000000..21ee61c4c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out.py @@ -0,0 +1,310 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_page_template_out_attributes import JsonApiPublisherDocumentPageTemplateOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentPageTemplateOutAttributes'] = JsonApiPublisherDocumentPageTemplateOutAttributes + + +class JsonApiPublisherDocumentPageTemplateOut(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',): { + 'PAGETEMPLATE': "pageTemplate", + }, + } + + 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': (JsonApiPublisherDocumentPageTemplateOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentPageTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "pageTemplate") + _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 + """JsonApiPublisherDocumentPageTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "pageTemplate") + _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_publisher_document_page_template_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_attributes.py new file mode 100644 index 000000000..ff9e7c4f1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_attributes.py @@ -0,0 +1,324 @@ +""" + 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_publisher_document_page_template_in_attributes_content import JsonApiPublisherDocumentPageTemplateInAttributesContent + globals()['JsonApiPublisherDocumentPageTemplateInAttributesContent'] = JsonApiPublisherDocumentPageTemplateInAttributesContent + + +class JsonApiPublisherDocumentPageTemplateOutAttributes(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 = { + ('title',): { + 'max_length': 255, + }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('description',): { + 'max_length': 10000, + }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + } + + @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': (JsonApiPublisherDocumentPageTemplateInAttributesContent,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'description': 'description', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplateOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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/json_api_publisher_document_page_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_document.py new file mode 100644 index 000000000..468f567ff --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_document.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_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_publisher_document_page_template_out import JsonApiPublisherDocumentPageTemplateOut + from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiPublisherDocumentPageTemplateOut'] = JsonApiPublisherDocumentPageTemplateOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiPublisherDocumentPageTemplateOutDocument(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': (JsonApiPublisherDocumentPageTemplateOut,), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # 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 + """JsonApiPublisherDocumentPageTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplateOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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 + """JsonApiPublisherDocumentPageTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplateOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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_publisher_document_page_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_list.py new file mode 100644 index 000000000..3a2e0bea1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_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_publisher_document_page_template_out_with_links import JsonApiPublisherDocumentPageTemplateOutWithLinks + 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()['JsonApiPublisherDocumentPageTemplateOutWithLinks'] = JsonApiPublisherDocumentPageTemplateOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiPublisherDocumentPageTemplateOutList(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': ([JsonApiPublisherDocumentPageTemplateOutWithLinks],), # 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 + """JsonApiPublisherDocumentPageTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentPageTemplateOutWithLinks]): + + 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 + """JsonApiPublisherDocumentPageTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentPageTemplateOutWithLinks]): + + 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_publisher_document_page_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_with_links.py new file mode 100644 index 000000000..fb0745caa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_out_with_links.py @@ -0,0 +1,361 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_page_template_out import JsonApiPublisherDocumentPageTemplateOut + from gooddata_api_client.model.json_api_publisher_document_page_template_out_attributes import JsonApiPublisherDocumentPageTemplateOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentPageTemplateOut'] = JsonApiPublisherDocumentPageTemplateOut + globals()['JsonApiPublisherDocumentPageTemplateOutAttributes'] = JsonApiPublisherDocumentPageTemplateOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiPublisherDocumentPageTemplateOutWithLinks(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',): { + 'PAGETEMPLATE': "pageTemplate", + }, + } + + 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': (JsonApiPublisherDocumentPageTemplateOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentPageTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentPageTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "pageTemplate") + _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 + """JsonApiPublisherDocumentPageTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentPageTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "pageTemplate") + _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': [ + JsonApiPublisherDocumentPageTemplateOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_patch.py new file mode 100644 index 000000000..97740f11c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_patch_attributes import JsonApiPublisherDocumentPageTemplatePatchAttributes + globals()['JsonApiPublisherDocumentPageTemplatePatchAttributes'] = JsonApiPublisherDocumentPageTemplatePatchAttributes + + +class JsonApiPublisherDocumentPageTemplatePatch(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',): { + 'PAGETEMPLATE': "pageTemplate", + }, + } + + 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': (JsonApiPublisherDocumentPageTemplatePatchAttributes,), # 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 + """JsonApiPublisherDocumentPageTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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 + """JsonApiPublisherDocumentPageTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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_publisher_document_page_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_patch_attributes.py new file mode 100644 index 000000000..8471aa9ef --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_patch_attributes.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_publisher_document_page_template_in_attributes_content import JsonApiPublisherDocumentPageTemplateInAttributesContent + globals()['JsonApiPublisherDocumentPageTemplateInAttributesContent'] = JsonApiPublisherDocumentPageTemplateInAttributesContent + + +class JsonApiPublisherDocumentPageTemplatePatchAttributes(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 + 'content': (JsonApiPublisherDocumentPageTemplateInAttributesContent,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPageTemplatePatchAttributes - 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 + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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 + """JsonApiPublisherDocumentPageTemplatePatchAttributes - 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 + content (JsonApiPublisherDocumentPageTemplateInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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_publisher_document_page_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_patch_document.py new file mode 100644 index 000000000..7698ff4aa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_patch import JsonApiPublisherDocumentPageTemplatePatch + globals()['JsonApiPublisherDocumentPageTemplatePatch'] = JsonApiPublisherDocumentPageTemplatePatch + + +class JsonApiPublisherDocumentPageTemplatePatchDocument(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': (JsonApiPublisherDocumentPageTemplatePatch,), # 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 + """JsonApiPublisherDocumentPageTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplatePatch): + + 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 + """JsonApiPublisherDocumentPageTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplatePatch): + + 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_publisher_document_page_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_post_optional_id.py new file mode 100644 index 000000000..b59f5677e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_in_attributes import JsonApiPublisherDocumentPageTemplateInAttributes + globals()['JsonApiPublisherDocumentPageTemplateInAttributes'] = JsonApiPublisherDocumentPageTemplateInAttributes + + +class JsonApiPublisherDocumentPageTemplatePostOptionalId(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',): { + 'PAGETEMPLATE': "pageTemplate", + }, + } + + 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': (JsonApiPublisherDocumentPageTemplateInAttributes,), # 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 + """JsonApiPublisherDocumentPageTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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 + """JsonApiPublisherDocumentPageTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPageTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "pageTemplate", must be one of ["pageTemplate", ] # 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', "pageTemplate") + _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_publisher_document_page_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_template_post_optional_id_document.py new file mode 100644 index 000000000..08cab857a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_page_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_publisher_document_page_template_post_optional_id import JsonApiPublisherDocumentPageTemplatePostOptionalId + globals()['JsonApiPublisherDocumentPageTemplatePostOptionalId'] = JsonApiPublisherDocumentPageTemplatePostOptionalId + + +class JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument(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': (JsonApiPublisherDocumentPageTemplatePostOptionalId,), # 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 + """JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplatePostOptionalId): + + 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 + """JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPageTemplatePostOptionalId): + + 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_publisher_document_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_patch.py new file mode 100644 index 000000000..743073330 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_patch_attributes import JsonApiPublisherDocumentPatchAttributes + globals()['JsonApiPublisherDocumentPatchAttributes'] = JsonApiPublisherDocumentPatchAttributes + + +class JsonApiPublisherDocumentPatch(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',): { + 'DOCUMENT': "document", + }, + } + + 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': (JsonApiPublisherDocumentPatchAttributes,), # 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 + """JsonApiPublisherDocumentPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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 + """JsonApiPublisherDocumentPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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_publisher_document_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_patch_attributes.py new file mode 100644 index 000000000..53e2991f6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_patch_attributes.py @@ -0,0 +1,302 @@ +""" + 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_publisher_document_in_attributes_content import JsonApiPublisherDocumentInAttributesContent + from gooddata_api_client.model.json_api_publisher_document_in_attributes_period import JsonApiPublisherDocumentInAttributesPeriod + globals()['JsonApiPublisherDocumentInAttributesContent'] = JsonApiPublisherDocumentInAttributesContent + globals()['JsonApiPublisherDocumentInAttributesPeriod'] = JsonApiPublisherDocumentInAttributesPeriod + + +class JsonApiPublisherDocumentPatchAttributes(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 + 'content': (JsonApiPublisherDocumentInAttributesContent,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'period': (JsonApiPublisherDocumentInAttributesPeriod,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'period': 'period', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentPatchAttributes - 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 + content (JsonApiPublisherDocumentInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + period (JsonApiPublisherDocumentInAttributesPeriod): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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 + """JsonApiPublisherDocumentPatchAttributes - 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 + content (JsonApiPublisherDocumentInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + period (JsonApiPublisherDocumentInAttributesPeriod): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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_publisher_document_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_patch_document.py new file mode 100644 index 000000000..df7ec3784 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_patch import JsonApiPublisherDocumentPatch + globals()['JsonApiPublisherDocumentPatch'] = JsonApiPublisherDocumentPatch + + +class JsonApiPublisherDocumentPatchDocument(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': (JsonApiPublisherDocumentPatch,), # 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 + """JsonApiPublisherDocumentPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPatch): + + 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 + """JsonApiPublisherDocumentPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPatch): + + 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_publisher_document_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_post_optional_id.py new file mode 100644 index 000000000..6884448dc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_in_attributes import JsonApiPublisherDocumentInAttributes + globals()['JsonApiPublisherDocumentInAttributes'] = JsonApiPublisherDocumentInAttributes + + +class JsonApiPublisherDocumentPostOptionalId(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',): { + 'DOCUMENT': "document", + }, + } + + 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': (JsonApiPublisherDocumentInAttributes,), # 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 + """JsonApiPublisherDocumentPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentInAttributes): + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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 + """JsonApiPublisherDocumentPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentInAttributes): + + Keyword Args: + type (str): Object type. defaults to "document", must be one of ["document", ] # 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', "document") + _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_publisher_document_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_post_optional_id_document.py new file mode 100644 index 000000000..af4b7e991 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_post_optional_id import JsonApiPublisherDocumentPostOptionalId + globals()['JsonApiPublisherDocumentPostOptionalId'] = JsonApiPublisherDocumentPostOptionalId + + +class JsonApiPublisherDocumentPostOptionalIdDocument(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': (JsonApiPublisherDocumentPostOptionalId,), # 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 + """JsonApiPublisherDocumentPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPostOptionalId): + + 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 + """JsonApiPublisherDocumentPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentPostOptionalId): + + 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_publisher_document_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in.py new file mode 100644 index 000000000..eef84373e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_in_attributes import JsonApiPublisherDocumentTemplateInAttributes + globals()['JsonApiPublisherDocumentTemplateInAttributes'] = JsonApiPublisherDocumentTemplateInAttributes + + +class JsonApiPublisherDocumentTemplateIn(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',): { + 'DOCUMENTTEMPLATE': "documentTemplate", + }, + } + + 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': (JsonApiPublisherDocumentTemplateInAttributes,), # 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 + """JsonApiPublisherDocumentTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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 + """JsonApiPublisherDocumentTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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_publisher_document_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in_attributes.py new file mode 100644 index 000000000..13bbdc799 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in_attributes.py @@ -0,0 +1,306 @@ +""" + 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_publisher_document_template_in_attributes_content import JsonApiPublisherDocumentTemplateInAttributesContent + globals()['JsonApiPublisherDocumentTemplateInAttributesContent'] = JsonApiPublisherDocumentTemplateInAttributesContent + + +class JsonApiPublisherDocumentTemplateInAttributes(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 = { + ('title',): { + '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 { + 'content': (JsonApiPublisherDocumentTemplateInAttributesContent,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplateInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplateInAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + description (str): [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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/json_api_publisher_document_template_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in_attributes_content.py new file mode 100644 index 000000000..83f3fb4a7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in_attributes_content.py @@ -0,0 +1,308 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_area_style import PublisherDocumentAreaStyle + from gooddata_api_client.model.publisher_document_attribute_filter_config import PublisherDocumentAttributeFilterConfig + from gooddata_api_client.model.publisher_document_defaults import PublisherDocumentDefaults + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_page import PublisherDocumentPage + from gooddata_api_client.model.publisher_document_section import PublisherDocumentSection + globals()['PublisherDocumentAreaStyle'] = PublisherDocumentAreaStyle + globals()['PublisherDocumentAttributeFilterConfig'] = PublisherDocumentAttributeFilterConfig + globals()['PublisherDocumentDefaults'] = PublisherDocumentDefaults + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentPage'] = PublisherDocumentPage + globals()['PublisherDocumentSection'] = PublisherDocumentSection + + +class JsonApiPublisherDocumentTemplateInAttributesContent(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 { + 'attribute_filter_configs': ([PublisherDocumentAttributeFilterConfig],), # noqa: E501 + 'defaults': (PublisherDocumentDefaults,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'format_locale': (str,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'pages': ([PublisherDocumentPage],), # noqa: E501 + 'sections': ([PublisherDocumentSection],), # noqa: E501 + 'style': (PublisherDocumentAreaStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_filter_configs': 'attributeFilterConfigs', # noqa: E501 + 'defaults': 'defaults', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'format_locale': 'formatLocale', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'pages': 'pages', # noqa: E501 + 'sections': 'sections', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplateInAttributesContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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 + """JsonApiPublisherDocumentTemplateInAttributesContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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_publisher_document_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_in_document.py new file mode 100644 index 000000000..9f1477427 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_in import JsonApiPublisherDocumentTemplateIn + globals()['JsonApiPublisherDocumentTemplateIn'] = JsonApiPublisherDocumentTemplateIn + + +class JsonApiPublisherDocumentTemplateInDocument(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': (JsonApiPublisherDocumentTemplateIn,), # 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 + """JsonApiPublisherDocumentTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplateIn): + + 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 + """JsonApiPublisherDocumentTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplateIn): + + 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_publisher_document_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out.py new file mode 100644 index 000000000..e29f444b2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out.py @@ -0,0 +1,310 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_template_out_attributes import JsonApiPublisherDocumentTemplateOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentTemplateOutAttributes'] = JsonApiPublisherDocumentTemplateOutAttributes + + +class JsonApiPublisherDocumentTemplateOut(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',): { + 'DOCUMENTTEMPLATE': "documentTemplate", + }, + } + + 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': (JsonApiPublisherDocumentTemplateOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "documentTemplate") + _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 + """JsonApiPublisherDocumentTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "documentTemplate") + _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_publisher_document_template_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_attributes.py new file mode 100644 index 000000000..88a715630 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_attributes.py @@ -0,0 +1,324 @@ +""" + 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_publisher_document_template_in_attributes_content import JsonApiPublisherDocumentTemplateInAttributesContent + globals()['JsonApiPublisherDocumentTemplateInAttributesContent'] = JsonApiPublisherDocumentTemplateInAttributesContent + + +class JsonApiPublisherDocumentTemplateOutAttributes(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 = { + ('title',): { + 'max_length': 255, + }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('description',): { + 'max_length': 10000, + }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + } + + @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': (JsonApiPublisherDocumentTemplateInAttributesContent,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'description': 'description', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'tags': 'tags', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplateOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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, content, title, version, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplateOutAttributes - a model defined in OpenAPI + + Args: + content (JsonApiPublisherDocumentTemplateInAttributesContent): + title (str): + version (str): Version of the content format. + + 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 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + tags ([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.content = content + self.title = title + 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/json_api_publisher_document_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_document.py new file mode 100644 index 000000000..e370f50cd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_document.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_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_publisher_document_template_out import JsonApiPublisherDocumentTemplateOut + from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiPublisherDocumentTemplateOut'] = JsonApiPublisherDocumentTemplateOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiPublisherDocumentTemplateOutDocument(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': (JsonApiPublisherDocumentTemplateOut,), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # 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 + """JsonApiPublisherDocumentTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplateOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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 + """JsonApiPublisherDocumentTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplateOut): + + 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 + meta (JsonApiAgentOutDocumentMeta): [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_publisher_document_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_list.py new file mode 100644 index 000000000..27d40261b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_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_publisher_document_template_out_with_links import JsonApiPublisherDocumentTemplateOutWithLinks + 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()['JsonApiPublisherDocumentTemplateOutWithLinks'] = JsonApiPublisherDocumentTemplateOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiPublisherDocumentTemplateOutList(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': ([JsonApiPublisherDocumentTemplateOutWithLinks],), # 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 + """JsonApiPublisherDocumentTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentTemplateOutWithLinks]): + + 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 + """JsonApiPublisherDocumentTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiPublisherDocumentTemplateOutWithLinks]): + + 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_publisher_document_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_with_links.py new file mode 100644 index 000000000..1b604b1db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_out_with_links.py @@ -0,0 +1,361 @@ +""" + 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_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships + from gooddata_api_client.model.json_api_publisher_document_template_out import JsonApiPublisherDocumentTemplateOut + from gooddata_api_client.model.json_api_publisher_document_template_out_attributes import JsonApiPublisherDocumentTemplateOutAttributes + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiPublisherDocumentTemplateOut'] = JsonApiPublisherDocumentTemplateOut + globals()['JsonApiPublisherDocumentTemplateOutAttributes'] = JsonApiPublisherDocumentTemplateOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiPublisherDocumentTemplateOutWithLinks(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',): { + 'DOCUMENTTEMPLATE': "documentTemplate", + }, + } + + 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': (JsonApiPublisherDocumentTemplateOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAggregatedFactOutMeta,), # 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 + 'meta': 'meta', # 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 + """JsonApiPublisherDocumentTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "documentTemplate") + _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 + """JsonApiPublisherDocumentTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiPublisherDocumentTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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 + relationships (JsonApiDashboardPluginOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "documentTemplate") + _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': [ + JsonApiPublisherDocumentTemplateOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_patch.py new file mode 100644 index 000000000..aa7d5527e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_patch_attributes import JsonApiPublisherDocumentTemplatePatchAttributes + globals()['JsonApiPublisherDocumentTemplatePatchAttributes'] = JsonApiPublisherDocumentTemplatePatchAttributes + + +class JsonApiPublisherDocumentTemplatePatch(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',): { + 'DOCUMENTTEMPLATE': "documentTemplate", + }, + } + + 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': (JsonApiPublisherDocumentTemplatePatchAttributes,), # 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 + """JsonApiPublisherDocumentTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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 + """JsonApiPublisherDocumentTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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_publisher_document_template_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_patch_attributes.py new file mode 100644 index 000000000..1fa112abc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_patch_attributes.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_publisher_document_template_in_attributes_content import JsonApiPublisherDocumentTemplateInAttributesContent + globals()['JsonApiPublisherDocumentTemplateInAttributesContent'] = JsonApiPublisherDocumentTemplateInAttributesContent + + +class JsonApiPublisherDocumentTemplatePatchAttributes(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 + 'content': (JsonApiPublisherDocumentTemplateInAttributesContent,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'version': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiPublisherDocumentTemplatePatchAttributes - 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 + content (JsonApiPublisherDocumentTemplateInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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 + """JsonApiPublisherDocumentTemplatePatchAttributes - 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 + content (JsonApiPublisherDocumentTemplateInAttributesContent): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + version (str): Version of the content format.. [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_publisher_document_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_patch_document.py new file mode 100644 index 000000000..4bc691e3e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_patch import JsonApiPublisherDocumentTemplatePatch + globals()['JsonApiPublisherDocumentTemplatePatch'] = JsonApiPublisherDocumentTemplatePatch + + +class JsonApiPublisherDocumentTemplatePatchDocument(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': (JsonApiPublisherDocumentTemplatePatch,), # 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 + """JsonApiPublisherDocumentTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplatePatch): + + 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 + """JsonApiPublisherDocumentTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplatePatch): + + 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_publisher_document_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_post_optional_id.py new file mode 100644 index 000000000..7179d9ce6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_in_attributes import JsonApiPublisherDocumentTemplateInAttributes + globals()['JsonApiPublisherDocumentTemplateInAttributes'] = JsonApiPublisherDocumentTemplateInAttributes + + +class JsonApiPublisherDocumentTemplatePostOptionalId(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',): { + 'DOCUMENTTEMPLATE': "documentTemplate", + }, + } + + 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': (JsonApiPublisherDocumentTemplateInAttributes,), # 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 + """JsonApiPublisherDocumentTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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 + """JsonApiPublisherDocumentTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiPublisherDocumentTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "documentTemplate", must be one of ["documentTemplate", ] # 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', "documentTemplate") + _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_publisher_document_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_template_post_optional_id_document.py new file mode 100644 index 000000000..0e3da2eae --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_publisher_document_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_publisher_document_template_post_optional_id import JsonApiPublisherDocumentTemplatePostOptionalId + globals()['JsonApiPublisherDocumentTemplatePostOptionalId'] = JsonApiPublisherDocumentTemplatePostOptionalId + + +class JsonApiPublisherDocumentTemplatePostOptionalIdDocument(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': (JsonApiPublisherDocumentTemplatePostOptionalId,), # 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 + """JsonApiPublisherDocumentTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplatePostOptionalId): + + 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 + """JsonApiPublisherDocumentTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiPublisherDocumentTemplatePostOptionalId): + + 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/localization_content.py b/gooddata-api-client/gooddata_api_client/model/localization_content.py new file mode 100644 index 000000000..83e5894a8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_content.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 LocalizationContent(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 { + 'value': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '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 + """LocalizationContent - 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,) + value (str, none_type): Language tag, or null when no language is 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__,) + + 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 + """LocalizationContent - 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,) + value (str, none_type): Language tag, or null when no language is 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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_count.py b/gooddata-api-client/gooddata_api_client/model/localization_count.py new file mode 100644 index 000000000..010b98cdc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_count.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_source_counts import LocalizationSourceCounts + globals()['LocalizationSourceCounts'] = LocalizationSourceCounts + + +class LocalizationCount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by_source': (LocalizationSourceCounts,), # noqa: E501 + 'total': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by_source': 'bySource', # noqa: E501 + 'total': 'total', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, by_source, total, *args, **kwargs): # noqa: E501 + """LocalizationCount - a model defined in OpenAPI + + Args: + by_source (LocalizationSourceCounts): + total (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_source = by_source + self.total = total + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, by_source, total, *args, **kwargs): # noqa: E501 + """LocalizationCount - a model defined in OpenAPI + + Args: + by_source (LocalizationSourceCounts): + total (int): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_source = by_source + self.total = total + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_data_statistics.py b/gooddata-api-client/gooddata_api_client/model/localization_data_statistics.py new file mode 100644 index 000000000..866c004e4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_data_statistics.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_statistics_locale import LocalizationStatisticsLocale + globals()['LocalizationStatisticsLocale'] = LocalizationStatisticsLocale + + +class LocalizationDataStatistics(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 { + 'locales': ([LocalizationStatisticsLocale],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'locales': 'locales', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, locales, *args, **kwargs): # noqa: E501 + """LocalizationDataStatistics - a model defined in OpenAPI + + Args: + locales ([LocalizationStatisticsLocale]): + + 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.locales = locales + 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, locales, *args, **kwargs): # noqa: E501 + """LocalizationDataStatistics - a model defined in OpenAPI + + Args: + locales ([LocalizationStatisticsLocale]): + + 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.locales = locales + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_default.py b/gooddata-api-client/gooddata_api_client/model/localization_default.py new file mode 100644 index 000000000..f7023515d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_default.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.localization_content import LocalizationContent + globals()['LocalizationContent'] = LocalizationContent + + +class LocalizationDefault(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 = { + ('source',): { + 'USER': "USER", + 'WORKSPACE': "WORKSPACE", + 'PARENT': "PARENT", + 'ORGANIZATION': "ORGANIZATION", + 'ENVIRONMENT': "ENVIRONMENT", + 'DEFAULT': "DEFAULT", + }, + } + + 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 { + 'content': (LocalizationContent,), # noqa: E501 + 'source': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'source': 'source', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, source, *args, **kwargs): # noqa: E501 + """LocalizationDefault - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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.source = source + 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, source, *args, **kwargs): # noqa: E501 + """LocalizationDefault - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_defaults.py b/gooddata-api-client/gooddata_api_client/model/localization_defaults.py new file mode 100644 index 000000000..f4f511b82 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_defaults.py @@ -0,0 +1,278 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_default import LocalizationDefault + globals()['LocalizationDefault'] = LocalizationDefault + + +class LocalizationDefaults(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_locale': (LocalizationDefault,), # noqa: E501 + 'locale': (LocalizationDefault,), # noqa: E501 + 'metadata_locale': (LocalizationDefault,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_locale': 'DATA_LOCALE', # noqa: E501 + 'locale': 'LOCALE', # noqa: E501 + 'metadata_locale': 'METADATA_LOCALE', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocalizationDefaults - 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_locale (LocalizationDefault): [optional] # noqa: E501 + locale (LocalizationDefault): [optional] # noqa: E501 + metadata_locale (LocalizationDefault): [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 + """LocalizationDefaults - 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_locale (LocalizationDefault): [optional] # noqa: E501 + locale (LocalizationDefault): [optional] # noqa: E501 + metadata_locale (LocalizationDefault): [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/localization_metadata_statistics.py b/gooddata-api-client/gooddata_api_client/model/localization_metadata_statistics.py new file mode 100644 index 000000000..ae3abf24f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_metadata_statistics.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_statistics_locale import LocalizationStatisticsLocale + globals()['LocalizationStatisticsLocale'] = LocalizationStatisticsLocale + + +class LocalizationMetadataStatistics(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 { + 'locales': ([LocalizationStatisticsLocale],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'locales': 'locales', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, locales, *args, **kwargs): # noqa: E501 + """LocalizationMetadataStatistics - a model defined in OpenAPI + + Args: + locales ([LocalizationStatisticsLocale]): + + 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.locales = locales + 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, locales, *args, **kwargs): # noqa: E501 + """LocalizationMetadataStatistics - a model defined in OpenAPI + + Args: + locales ([LocalizationStatisticsLocale]): + + 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.locales = locales + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_resolved_value.py b/gooddata-api-client/gooddata_api_client/model/localization_resolved_value.py new file mode 100644 index 000000000..08ad13435 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_resolved_value.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_content import LocalizationContent + globals()['LocalizationContent'] = LocalizationContent + + +class LocalizationResolvedValue(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 = { + ('source',): { + 'USER': "USER", + 'WORKSPACE': "WORKSPACE", + 'PARENT': "PARENT", + 'ORGANIZATION': "ORGANIZATION", + 'ENVIRONMENT': "ENVIRONMENT", + 'DEFAULT': "DEFAULT", + }, + } + + 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 { + 'content': (LocalizationContent,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'origin_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'source': 'source', # noqa: E501 + 'origin_id': 'originId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, source, *args, **kwargs): # noqa: E501 + """LocalizationResolvedValue - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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,) + origin_id (str, none_type): The ancestor workspace that sets the value. Null unless the source is PARENT.. [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.content = content + self.source = source + 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, source, *args, **kwargs): # noqa: E501 + """LocalizationResolvedValue - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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,) + origin_id (str, none_type): The ancestor workspace that sets the value. Null unless the source is PARENT.. [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.content = content + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_resolved_values.py b/gooddata-api-client/gooddata_api_client/model/localization_resolved_values.py new file mode 100644 index 000000000..c4b922ef7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_resolved_values.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_resolved_value import LocalizationResolvedValue + globals()['LocalizationResolvedValue'] = LocalizationResolvedValue + + +class LocalizationResolvedValues(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_locale': (LocalizationResolvedValue,), # noqa: E501 + 'locale': (LocalizationResolvedValue,), # noqa: E501 + 'metadata_locale': (LocalizationResolvedValue,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_locale': 'DATA_LOCALE', # noqa: E501 + 'locale': 'LOCALE', # noqa: E501 + 'metadata_locale': 'METADATA_LOCALE', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data_locale, locale, metadata_locale, *args, **kwargs): # noqa: E501 + """LocalizationResolvedValues - a model defined in OpenAPI + + Args: + data_locale (LocalizationResolvedValue): + locale (LocalizationResolvedValue): + metadata_locale (LocalizationResolvedValue): + + 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_locale = data_locale + self.locale = locale + self.metadata_locale = metadata_locale + 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_locale, locale, metadata_locale, *args, **kwargs): # noqa: E501 + """LocalizationResolvedValues - a model defined in OpenAPI + + Args: + data_locale (LocalizationResolvedValue): + locale (LocalizationResolvedValue): + metadata_locale (LocalizationResolvedValue): + + 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_locale = data_locale + self.locale = locale + self.metadata_locale = metadata_locale + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py b/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py new file mode 100644 index 000000000..ead1bc6e2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_setting_usage.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_count import LocalizationCount + globals()['LocalizationCount'] = LocalizationCount + + +class LocalizationSettingUsage(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 { + 'users': (LocalizationCount,), # noqa: E501 + 'workspaces': (LocalizationCount,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'users': 'users', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, users, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationSettingUsage - a model defined in OpenAPI + + Args: + users (LocalizationCount): + workspaces (LocalizationCount): + + 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.users = users + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, users, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationSettingUsage - a model defined in OpenAPI + + Args: + users (LocalizationCount): + workspaces (LocalizationCount): + + 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.users = users + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_setting_usages.py b/gooddata-api-client/gooddata_api_client/model/localization_setting_usages.py new file mode 100644 index 000000000..163a2819c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_setting_usages.py @@ -0,0 +1,278 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_setting_usage import LocalizationSettingUsage + globals()['LocalizationSettingUsage'] = LocalizationSettingUsage + + +class LocalizationSettingUsages(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_locale': (LocalizationSettingUsage,), # noqa: E501 + 'locale': (LocalizationSettingUsage,), # noqa: E501 + 'metadata_locale': (LocalizationSettingUsage,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_locale': 'DATA_LOCALE', # noqa: E501 + 'locale': 'LOCALE', # noqa: E501 + 'metadata_locale': 'METADATA_LOCALE', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocalizationSettingUsages - 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_locale (LocalizationSettingUsage): [optional] # noqa: E501 + locale (LocalizationSettingUsage): [optional] # noqa: E501 + metadata_locale (LocalizationSettingUsage): [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 + """LocalizationSettingUsages - 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_locale (LocalizationSettingUsage): [optional] # noqa: E501 + locale (LocalizationSettingUsage): [optional] # noqa: E501 + metadata_locale (LocalizationSettingUsage): [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/localization_source_counts.py b/gooddata-api-client/gooddata_api_client/model/localization_source_counts.py new file mode 100644 index 000000000..2d7e3d741 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_source_counts.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 + + + +class LocalizationSourceCounts(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 { + 'default': (int,), # noqa: E501 + 'environment': (int,), # noqa: E501 + 'organization': (int,), # noqa: E501 + 'parent': (int,), # noqa: E501 + 'user': (int,), # noqa: E501 + 'workspace': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'default': 'DEFAULT', # noqa: E501 + 'environment': 'ENVIRONMENT', # noqa: E501 + 'organization': 'ORGANIZATION', # noqa: E501 + 'parent': 'PARENT', # noqa: E501 + 'user': 'USER', # noqa: E501 + 'workspace': 'WORKSPACE', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocalizationSourceCounts - 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,) + default (int): [optional] # noqa: E501 + environment (int): [optional] # noqa: E501 + organization (int): [optional] # noqa: E501 + parent (int): [optional] # noqa: E501 + user (int): [optional] # noqa: E501 + workspace (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 + """LocalizationSourceCounts - 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,) + default (int): [optional] # noqa: E501 + environment (int): [optional] # noqa: E501 + organization (int): [optional] # noqa: E501 + parent (int): [optional] # noqa: E501 + user (int): [optional] # noqa: E501 + workspace (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/localization_statistics.py b/gooddata-api-client/gooddata_api_client/model/localization_statistics.py new file mode 100644 index 000000000..8a4167e06 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_statistics.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.localization_data_statistics import LocalizationDataStatistics + from gooddata_api_client.model.localization_metadata_statistics import LocalizationMetadataStatistics + globals()['LocalizationDataStatistics'] = LocalizationDataStatistics + globals()['LocalizationMetadataStatistics'] = LocalizationMetadataStatistics + + +class LocalizationStatistics(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': (LocalizationDataStatistics,), # noqa: E501 + 'metadata': (LocalizationMetadataStatistics,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data': 'data', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data, metadata, *args, **kwargs): # noqa: E501 + """LocalizationStatistics - a model defined in OpenAPI + + Args: + data (LocalizationDataStatistics): + metadata (LocalizationMetadataStatistics): + + 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 + self.metadata = metadata + 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, metadata, *args, **kwargs): # noqa: E501 + """LocalizationStatistics - a model defined in OpenAPI + + Args: + data (LocalizationDataStatistics): + metadata (LocalizationMetadataStatistics): + + 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 + self.metadata = metadata + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_statistics_locale.py b/gooddata-api-client/gooddata_api_client/model/localization_statistics_locale.py new file mode 100644 index 000000000..4d5328eec --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_statistics_locale.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class LocalizationStatisticsLocale(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'locale': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'locale': 'locale', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, locale, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsLocale - a model defined in OpenAPI + + Args: + locale (str): Language tag. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.locale = locale + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, locale, *args, **kwargs): # noqa: E501 + """LocalizationStatisticsLocale - a model defined in OpenAPI + + Args: + locale (str): Language tag. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.locale = locale + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_usage.py b/gooddata-api-client/gooddata_api_client/model/localization_usage.py new file mode 100644 index 000000000..a43c1bbaa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage.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.localization_defaults import LocalizationDefaults + from gooddata_api_client.model.localization_usage_value import LocalizationUsageValue + globals()['LocalizationDefaults'] = LocalizationDefaults + globals()['LocalizationUsageValue'] = LocalizationUsageValue + + +class LocalizationUsage(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 { + 'defaults': (LocalizationDefaults,), # noqa: E501 + 'values': ([LocalizationUsageValue],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'defaults': 'defaults', # noqa: E501 + 'values': 'values', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, defaults, values, *args, **kwargs): # noqa: E501 + """LocalizationUsage - a model defined in OpenAPI + + Args: + defaults (LocalizationDefaults): + values ([LocalizationUsageValue]): + + 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.defaults = defaults + self.values = values + 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, defaults, values, *args, **kwargs): # noqa: E501 + """LocalizationUsage - a model defined in OpenAPI + + Args: + defaults (LocalizationDefaults): + values ([LocalizationUsageValue]): + + 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.defaults = defaults + self.values = values + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_usage_user.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_user.py new file mode 100644 index 000000000..73804b479 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_user.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.localization_user_values import LocalizationUserValues + globals()['LocalizationUserValues'] = LocalizationUserValues + + +class LocalizationUsageUser(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 = { + ('source',): { + 'USER': "USER", + 'WORKSPACE': "WORKSPACE", + 'PARENT': "PARENT", + 'ORGANIZATION': "ORGANIZATION", + 'ENVIRONMENT': "ENVIRONMENT", + 'DEFAULT': "DEFAULT", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by_setting': (LocalizationUserValues,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'email': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by_setting': 'bySetting', # noqa: E501 + 'id': 'id', # noqa: E501 + 'source': 'source', # noqa: E501 + 'email': 'email', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, by_setting, id, source, *args, **kwargs): # noqa: E501 + """LocalizationUsageUser - a model defined in OpenAPI + + Args: + by_setting (LocalizationUserValues): + id (str): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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,) + email (str, none_type): [optional] # noqa: E501 + name (str, none_type): First and last name. Null when the user has neither.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_setting = by_setting + self.id = id + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, by_setting, id, source, *args, **kwargs): # noqa: E501 + """LocalizationUsageUser - a model defined in OpenAPI + + Args: + by_setting (LocalizationUserValues): + id (str): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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,) + email (str, none_type): [optional] # noqa: E501 + name (str, none_type): First and last name. Null when the user has neither.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_setting = by_setting + self.id = id + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_usage_users.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_users.py new file mode 100644 index 000000000..d18f696f8 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_users.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_usage_user import LocalizationUsageUser + globals()['LocalizationUsageUser'] = LocalizationUsageUser + + +class LocalizationUsageUsers(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total_count': (int,), # noqa: E501 + 'users': ([LocalizationUsageUser],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_count': 'totalCount', # noqa: E501 + 'users': 'users', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total_count, users, *args, **kwargs): # noqa: E501 + """LocalizationUsageUsers - a model defined in OpenAPI + + Args: + total_count (int): The total number of users that match the filters. + users ([LocalizationUsageUser]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_count = total_count + self.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, total_count, users, *args, **kwargs): # noqa: E501 + """LocalizationUsageUsers - a model defined in OpenAPI + + Args: + total_count (int): The total number of users that match the filters. + users ([LocalizationUsageUser]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_count = total_count + self.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/localization_usage_value.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_value.py new file mode 100644 index 000000000..168293d1d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_value.py @@ -0,0 +1,298 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_content import LocalizationContent + from gooddata_api_client.model.localization_count import LocalizationCount + from gooddata_api_client.model.localization_setting_usages import LocalizationSettingUsages + globals()['LocalizationContent'] = LocalizationContent + globals()['LocalizationCount'] = LocalizationCount + globals()['LocalizationSettingUsages'] = LocalizationSettingUsages + + +class LocalizationUsageValue(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by_setting': (LocalizationSettingUsages,), # noqa: E501 + 'content': (LocalizationContent,), # noqa: E501 + 'users': (LocalizationCount,), # noqa: E501 + 'workspaces': (LocalizationCount,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by_setting': 'bySetting', # noqa: E501 + 'content': 'content', # noqa: E501 + 'users': 'users', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, by_setting, content, users, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationUsageValue - a model defined in OpenAPI + + Args: + by_setting (LocalizationSettingUsages): + content (LocalizationContent): + users (LocalizationCount): + workspaces (LocalizationCount): + + 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.by_setting = by_setting + self.content = content + self.users = users + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, by_setting, content, users, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationUsageValue - a model defined in OpenAPI + + Args: + by_setting (LocalizationSettingUsages): + content (LocalizationContent): + users (LocalizationCount): + workspaces (LocalizationCount): + + 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.by_setting = by_setting + self.content = content + self.users = users + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_usage_workspace.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_workspace.py new file mode 100644 index 000000000..562fc7811 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_workspace.py @@ -0,0 +1,312 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_resolved_values import LocalizationResolvedValues + globals()['LocalizationResolvedValues'] = LocalizationResolvedValues + + +class LocalizationUsageWorkspace(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 = { + ('source',): { + 'USER': "USER", + 'WORKSPACE': "WORKSPACE", + 'PARENT': "PARENT", + 'ORGANIZATION': "ORGANIZATION", + 'ENVIRONMENT': "ENVIRONMENT", + 'DEFAULT': "DEFAULT", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by_setting': (LocalizationResolvedValues,), # noqa: E501 + 'children_count': (int,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'parent_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by_setting': 'bySetting', # noqa: E501 + 'children_count': 'childrenCount', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'source': 'source', # noqa: E501 + 'parent_id': 'parentId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, by_setting, children_count, id, name, source, *args, **kwargs): # noqa: E501 + """LocalizationUsageWorkspace - a model defined in OpenAPI + + Args: + by_setting (LocalizationResolvedValues): + children_count (int): Number of direct child workspaces. + id (str): + name (str): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_id (str, none_type): The parent workspace, or null for a root workspace.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_setting = by_setting + self.children_count = children_count + self.id = id + self.name = name + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, by_setting, children_count, id, name, source, *args, **kwargs): # noqa: E501 + """LocalizationUsageWorkspace - a model defined in OpenAPI + + Args: + by_setting (LocalizationResolvedValues): + children_count (int): Number of direct child workspaces. + id (str): + name (str): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_id (str, none_type): The parent workspace, or null for a root workspace.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.by_setting = by_setting + self.children_count = children_count + self.id = id + self.name = name + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_usage_workspaces.py b/gooddata-api-client/gooddata_api_client/model/localization_usage_workspaces.py new file mode 100644 index 000000000..12f65f3d4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_usage_workspaces.py @@ -0,0 +1,282 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_usage_workspace import LocalizationUsageWorkspace + globals()['LocalizationUsageWorkspace'] = LocalizationUsageWorkspace + + +class LocalizationUsageWorkspaces(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total_count': (int,), # noqa: E501 + 'workspaces': ([LocalizationUsageWorkspace],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_count': 'totalCount', # noqa: E501 + 'workspaces': 'workspaces', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total_count, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationUsageWorkspaces - a model defined in OpenAPI + + Args: + total_count (int): The total number of workspaces that match the filters. + workspaces ([LocalizationUsageWorkspace]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_count = total_count + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total_count, workspaces, *args, **kwargs): # noqa: E501 + """LocalizationUsageWorkspaces - a model defined in OpenAPI + + Args: + total_count (int): The total number of workspaces that match the filters. + workspaces ([LocalizationUsageWorkspace]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_count = total_count + self.workspaces = workspaces + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_user_value.py b/gooddata-api-client/gooddata_api_client/model/localization_user_value.py new file mode 100644 index 000000000..ecd423ef0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_user_value.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.localization_content import LocalizationContent + globals()['LocalizationContent'] = LocalizationContent + + +class LocalizationUserValue(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 = { + ('source',): { + 'USER': "USER", + 'WORKSPACE': "WORKSPACE", + 'PARENT': "PARENT", + 'ORGANIZATION': "ORGANIZATION", + 'ENVIRONMENT': "ENVIRONMENT", + 'DEFAULT': "DEFAULT", + }, + } + + 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 { + 'content': (LocalizationContent,), # noqa: E501 + 'source': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'source': 'source', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, source, *args, **kwargs): # noqa: E501 + """LocalizationUserValue - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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.source = source + 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, source, *args, **kwargs): # noqa: E501 + """LocalizationUserValue - a model defined in OpenAPI + + Args: + content (LocalizationContent): + source (str): Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default. + + 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.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/localization_user_values.py b/gooddata-api-client/gooddata_api_client/model/localization_user_values.py new file mode 100644 index 000000000..eec39213b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/localization_user_values.py @@ -0,0 +1,278 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.localization_user_value import LocalizationUserValue + globals()['LocalizationUserValue'] = LocalizationUserValue + + +class LocalizationUserValues(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_locale': (LocalizationUserValue,), # noqa: E501 + 'locale': (LocalizationUserValue,), # noqa: E501 + 'metadata_locale': (LocalizationUserValue,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_locale': 'DATA_LOCALE', # noqa: E501 + 'locale': 'LOCALE', # noqa: E501 + 'metadata_locale': 'METADATA_LOCALE', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LocalizationUserValues - 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_locale (LocalizationUserValue): [optional] # noqa: E501 + locale (LocalizationUserValue): [optional] # noqa: E501 + metadata_locale (LocalizationUserValue): [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 + """LocalizationUserValues - 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_locale (LocalizationUserValue): [optional] # noqa: E501 + locale (LocalizationUserValue): [optional] # noqa: E501 + metadata_locale (LocalizationUserValue): [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/publisher_document_arbitrary_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_arbitrary_attribute_filter.py new file mode 100644 index 000000000..abe0839e5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_arbitrary_attribute_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.publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter import PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter + globals()['PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter'] = PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter + + +class PublisherDocumentArbitraryAttributeFilter(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 { + 'arbitrary_attribute_filter': (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'arbitrary_attribute_filter': 'arbitraryAttributeFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, arbitrary_attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentArbitraryAttributeFilter - a model defined in OpenAPI + + Args: + arbitrary_attribute_filter (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter): + + 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.arbitrary_attribute_filter = arbitrary_attribute_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, arbitrary_attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentArbitraryAttributeFilter - a model defined in OpenAPI + + Args: + arbitrary_attribute_filter (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter): + + 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.arbitrary_attribute_filter = arbitrary_attribute_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/publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter.py new file mode 100644 index 000000000..95621b0d3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter.py @@ -0,0 +1,317 @@ +""" + 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.publisher_document_attribute_filter_by_date import PublisherDocumentAttributeFilterByDate + from gooddata_api_client.model.publisher_document_attribute_filter_parent import PublisherDocumentAttributeFilterParent + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentAttributeFilterByDate'] = PublisherDocumentAttributeFilterByDate + globals()['PublisherDocumentAttributeFilterParent'] = PublisherDocumentAttributeFilterParent + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter(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 = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'display_form': (PublisherDocumentObjRef,), # noqa: E501 + 'negative_selection': (bool,), # noqa: E501 + 'values': ([str],), # noqa: E501 + 'filter_elements_by': ([PublisherDocumentAttributeFilterParent],), # noqa: E501 + 'filter_elements_by_date': ([PublisherDocumentAttributeFilterByDate],), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'validate_elements_by': ([PublisherDocumentObjRef],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'display_form': 'displayForm', # noqa: E501 + 'negative_selection': 'negativeSelection', # noqa: E501 + 'values': 'values', # noqa: E501 + 'filter_elements_by': 'filterElementsBy', # noqa: E501 + 'filter_elements_by_date': 'filterElementsByDate', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 + 'title': 'title', # noqa: E501 + 'validate_elements_by': 'validateElementsBy', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, display_form, negative_selection, values, *args, **kwargs): # noqa: E501 + """PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + negative_selection (bool): + values ([str]): Values; `null` stands for an empty value. + + 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,) + filter_elements_by ([PublisherDocumentAttributeFilterParent]): [optional] # noqa: E501 + filter_elements_by_date ([PublisherDocumentAttributeFilterByDate]): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + validate_elements_by ([PublisherDocumentObjRef]): [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.display_form = display_form + self.negative_selection = negative_selection + self.values = values + 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, display_form, negative_selection, values, *args, **kwargs): # noqa: E501 + """PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + negative_selection (bool): + values ([str]): Values; `null` stands for an empty value. + + 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,) + filter_elements_by ([PublisherDocumentAttributeFilterParent]): [optional] # noqa: E501 + filter_elements_by_date ([PublisherDocumentAttributeFilterByDate]): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + validate_elements_by ([PublisherDocumentObjRef]): [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.display_form = display_form + self.negative_selection = negative_selection + self.values = values + 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/publisher_document_area_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_area_style.py new file mode 100644 index 000000000..99ded7795 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_area_style.py @@ -0,0 +1,357 @@ +""" + 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.publisher_document_area_style_gap import PublisherDocumentAreaStyleGap + globals()['PublisherDocumentAreaStyleGap'] = PublisherDocumentAreaStyleGap + + +class PublisherDocumentAreaStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + } + + @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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'gap': (PublisherDocumentAreaStyleGap,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'gap': 'gap', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAreaStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [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 + """PublisherDocumentAreaStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [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/publisher_document_area_style_gap.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_area_style_gap.py new file mode 100644 index 000000000..91f1295e1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_area_style_gap.py @@ -0,0 +1,260 @@ +""" + 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 PublisherDocumentAreaStyleGap(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 { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAreaStyleGap - 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,) + """ + + _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 + """PublisherDocumentAreaStyleGap - 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,) + """ + + _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/publisher_document_attribute_elements.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements.py new file mode 100644 index 000000000..c69fe6a5d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements.py @@ -0,0 +1,327 @@ +""" + 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.publisher_document_attribute_elements_by_uri import PublisherDocumentAttributeElementsByUri + from gooddata_api_client.model.publisher_document_attribute_elements_by_value import PublisherDocumentAttributeElementsByValue + globals()['PublisherDocumentAttributeElementsByUri'] = PublisherDocumentAttributeElementsByUri + globals()['PublisherDocumentAttributeElementsByValue'] = PublisherDocumentAttributeElementsByValue + + +class PublisherDocumentAttributeElements(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 { + 'values': ([str],), # noqa: E501 + 'uris': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'values': 'values', # noqa: E501 + 'uris': 'uris', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeElements - 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,) + values ([str]): Element values; `null` stands for an empty value.. [optional] # noqa: E501 + uris ([str]): Element URIs; `null` stands for an empty value.. [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 + """PublisherDocumentAttributeElements - 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,) + values ([str]): Element values; `null` stands for an empty value.. [optional] # noqa: E501 + uris ([str]): Element URIs; `null` stands for an empty value.. [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': [ + PublisherDocumentAttributeElementsByUri, + PublisherDocumentAttributeElementsByValue, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements_by_uri.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements_by_uri.py new file mode 100644 index 000000000..efa651c13 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements_by_uri.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class PublisherDocumentAttributeElementsByUri(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 { + 'uris': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'uris': 'uris', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, uris, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeElementsByUri - a model defined in OpenAPI + + Args: + uris ([str]): Element URIs; `null` stands for an empty value. + + 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.uris = uris + 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, uris, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeElementsByUri - a model defined in OpenAPI + + Args: + uris ([str]): Element URIs; `null` stands for an empty value. + + 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.uris = uris + 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/publisher_document_attribute_elements_by_value.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements_by_value.py new file mode 100644 index 000000000..54900ad78 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_elements_by_value.py @@ -0,0 +1,270 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class PublisherDocumentAttributeElementsByValue(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 { + 'values': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'values': 'values', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, values, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeElementsByValue - a model defined in OpenAPI + + Args: + values ([str]): Element values; `null` stands for an empty value. + + 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.values = values + 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, values, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeElementsByValue - a model defined in OpenAPI + + Args: + values ([str]): Element values; `null` stands for an empty value. + + 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.values = values + 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/publisher_document_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter.py new file mode 100644 index 000000000..c3dd058d7 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_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.publisher_document_attribute_filter_attribute_filter import PublisherDocumentAttributeFilterAttributeFilter + globals()['PublisherDocumentAttributeFilterAttributeFilter'] = PublisherDocumentAttributeFilterAttributeFilter + + +class PublisherDocumentAttributeFilter(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 { + 'attribute_filter': (PublisherDocumentAttributeFilterAttributeFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_filter': 'attributeFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilter - a model defined in OpenAPI + + Args: + attribute_filter (PublisherDocumentAttributeFilterAttributeFilter): + + 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.attribute_filter = attribute_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, attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilter - a model defined in OpenAPI + + Args: + attribute_filter (PublisherDocumentAttributeFilterAttributeFilter): + + 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.attribute_filter = attribute_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/publisher_document_attribute_filter_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_attribute_filter.py new file mode 100644 index 000000000..8d3b28a54 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_attribute_filter.py @@ -0,0 +1,327 @@ +""" + 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.publisher_document_attribute_elements import PublisherDocumentAttributeElements + from gooddata_api_client.model.publisher_document_attribute_filter_by_date import PublisherDocumentAttributeFilterByDate + from gooddata_api_client.model.publisher_document_attribute_filter_parent import PublisherDocumentAttributeFilterParent + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentAttributeElements'] = PublisherDocumentAttributeElements + globals()['PublisherDocumentAttributeFilterByDate'] = PublisherDocumentAttributeFilterByDate + globals()['PublisherDocumentAttributeFilterParent'] = PublisherDocumentAttributeFilterParent + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentAttributeFilterAttributeFilter(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 = { + ('selection_mode',): { + 'SINGLE': "single", + 'MULTI': "multi", + }, + } + + validations = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'attribute_elements': (PublisherDocumentAttributeElements,), # noqa: E501 + 'display_form': (PublisherDocumentObjRef,), # noqa: E501 + 'negative_selection': (bool,), # noqa: E501 + 'filter_elements_by': ([PublisherDocumentAttributeFilterParent],), # noqa: E501 + 'filter_elements_by_date': ([PublisherDocumentAttributeFilterByDate],), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + 'selection_mode': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'validate_elements_by': ([PublisherDocumentObjRef],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_elements': 'attributeElements', # noqa: E501 + 'display_form': 'displayForm', # noqa: E501 + 'negative_selection': 'negativeSelection', # noqa: E501 + 'filter_elements_by': 'filterElementsBy', # noqa: E501 + 'filter_elements_by_date': 'filterElementsByDate', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 + 'selection_mode': 'selectionMode', # noqa: E501 + 'title': 'title', # noqa: E501 + 'validate_elements_by': 'validateElementsBy', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attribute_elements, display_form, negative_selection, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterAttributeFilter - a model defined in OpenAPI + + Args: + attribute_elements (PublisherDocumentAttributeElements): + display_form (PublisherDocumentObjRef): + negative_selection (bool): + + 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,) + filter_elements_by ([PublisherDocumentAttributeFilterParent]): Parent filters that limit the offered elements.. [optional] # noqa: E501 + filter_elements_by_date ([PublisherDocumentAttributeFilterByDate]): Date filters that limit the offered elements.. [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + selection_mode (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + validate_elements_by ([PublisherDocumentObjRef]): [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.attribute_elements = attribute_elements + self.display_form = display_form + self.negative_selection = negative_selection + 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, attribute_elements, display_form, negative_selection, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterAttributeFilter - a model defined in OpenAPI + + Args: + attribute_elements (PublisherDocumentAttributeElements): + display_form (PublisherDocumentObjRef): + negative_selection (bool): + + 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,) + filter_elements_by ([PublisherDocumentAttributeFilterParent]): Parent filters that limit the offered elements.. [optional] # noqa: E501 + filter_elements_by_date ([PublisherDocumentAttributeFilterByDate]): Date filters that limit the offered elements.. [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + selection_mode (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + validate_elements_by ([PublisherDocumentObjRef]): [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.attribute_elements = attribute_elements + self.display_form = display_form + self.negative_selection = negative_selection + 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/publisher_document_attribute_filter_by_date.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_by_date.py new file mode 100644 index 000000000..b48134d53 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_by_date.py @@ -0,0 +1,286 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentAttributeFilterByDate(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 { + 'filter_local_identifier': (str,), # noqa: E501 + 'is_common_date': (bool,), # noqa: E501 + 'data_set': (PublisherDocumentObjRef,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filter_local_identifier': 'filterLocalIdentifier', # noqa: E501 + 'is_common_date': 'isCommonDate', # noqa: E501 + 'data_set': 'dataSet', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, filter_local_identifier, is_common_date, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterByDate - a model defined in OpenAPI + + Args: + filter_local_identifier (str): + is_common_date (bool): + + 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_set (PublisherDocumentObjRef): [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.filter_local_identifier = filter_local_identifier + self.is_common_date = is_common_date + 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, filter_local_identifier, is_common_date, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterByDate - a model defined in OpenAPI + + Args: + filter_local_identifier (str): + is_common_date (bool): + + 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_set (PublisherDocumentObjRef): [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.filter_local_identifier = filter_local_identifier + self.is_common_date = is_common_date + 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/publisher_document_attribute_filter_config.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_config.py new file mode 100644 index 000000000..d526ae39b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_config.py @@ -0,0 +1,303 @@ +""" + 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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentAttributeFilterConfig(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 = { + ('mode',): { + 'READONLY': "readonly", + 'HIDDEN': "hidden", + 'ACTIVE': "active", + }, + ('selection_type',): { + 'LIST': "list", + 'TEXT': "text", + 'LISTORTEXT': "listOrText", + }, + } + + validations = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'local_identifier': (str,), # noqa: E501 + 'display_as_label': (PublisherDocumentObjRef,), # noqa: E501 + 'mode': (str,), # noqa: E501 + 'selection_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'local_identifier': 'localIdentifier', # noqa: E501 + 'display_as_label': 'displayAsLabel', # noqa: E501 + 'mode': 'mode', # noqa: E501 + 'selection_type': 'selectionType', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, local_identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterConfig - a model defined in OpenAPI + + Args: + local_identifier (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,) + display_as_label (PublisherDocumentObjRef): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + selection_type (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.local_identifier = local_identifier + 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, local_identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterConfig - a model defined in OpenAPI + + Args: + local_identifier (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,) + display_as_label (PublisherDocumentObjRef): [optional] # noqa: E501 + mode (str): [optional] # noqa: E501 + selection_type (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.local_identifier = local_identifier + 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/publisher_document_attribute_filter_parent.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_parent.py new file mode 100644 index 000000000..bb460695e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_parent.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.publisher_document_attribute_filter_parent_over import PublisherDocumentAttributeFilterParentOver + globals()['PublisherDocumentAttributeFilterParentOver'] = PublisherDocumentAttributeFilterParentOver + + +class PublisherDocumentAttributeFilterParent(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 { + 'filter_local_identifier': (str,), # noqa: E501 + 'over': (PublisherDocumentAttributeFilterParentOver,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filter_local_identifier': 'filterLocalIdentifier', # noqa: E501 + 'over': 'over', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, filter_local_identifier, over, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterParent - a model defined in OpenAPI + + Args: + filter_local_identifier (str): + over (PublisherDocumentAttributeFilterParentOver): + + 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.filter_local_identifier = filter_local_identifier + self.over = over + 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, filter_local_identifier, over, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterParent - a model defined in OpenAPI + + Args: + filter_local_identifier (str): + over (PublisherDocumentAttributeFilterParentOver): + + 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.filter_local_identifier = filter_local_identifier + self.over = over + 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/publisher_document_attribute_filter_parent_over.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_parent_over.py new file mode 100644 index 000000000..98ac31bf0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_parent_over.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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentAttributeFilterParentOver(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 { + 'attributes': ([PublisherDocumentObjRef],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attributes': 'attributes', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, attributes, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterParentOver - a model defined in OpenAPI + + Args: + attributes ([PublisherDocumentObjRef]): + + 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.attributes = attributes + 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 + """PublisherDocumentAttributeFilterParentOver - a model defined in OpenAPI + + Args: + attributes ([PublisherDocumentObjRef]): + + 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.attributes = attributes + 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/publisher_document_attribute_filter_reference.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_reference.py new file mode 100644 index 000000000..c66495c75 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_attribute_filter_reference.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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentAttributeFilterReference(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',): { + 'ATTRIBUTEFILTERREFERENCE': "attributeFilterReference", + }, + } + + 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 { + 'display_form': (PublisherDocumentObjRef,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'display_form': 'displayForm', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, display_form, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterReference - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "attributeFilterReference", must be one of ["attributeFilterReference", ] # 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', "attributeFilterReference") + _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.display_form = display_form + 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, display_form, *args, **kwargs): # noqa: E501 + """PublisherDocumentAttributeFilterReference - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "attributeFilterReference", must be one of ["attributeFilterReference", ] # 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', "attributeFilterReference") + _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.display_form = display_form + 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/publisher_document_auto_visibility.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_auto_visibility.py new file mode 100644 index 000000000..478697a99 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_auto_visibility.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.publisher_document_auto_visibility_visible import PublisherDocumentAutoVisibilityVisible + globals()['PublisherDocumentAutoVisibilityVisible'] = PublisherDocumentAutoVisibilityVisible + + +class PublisherDocumentAutoVisibility(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 { + 'visible': (PublisherDocumentAutoVisibilityVisible,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAutoVisibility - 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,) + visible (PublisherDocumentAutoVisibilityVisible): [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 + """PublisherDocumentAutoVisibility - 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,) + visible (PublisherDocumentAutoVisibilityVisible): [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/publisher_document_auto_visibility_visible.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_auto_visibility_visible.py new file mode 100644 index 000000000..8ee0034a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_auto_visibility_visible.py @@ -0,0 +1,260 @@ +""" + 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 PublisherDocumentAutoVisibilityVisible(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 { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAutoVisibilityVisible - 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,) + """ + + _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 + """PublisherDocumentAutoVisibilityVisible - 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,) + """ + + _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/publisher_document_axis_display.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_display.py new file mode 100644 index 000000000..c88b4f8ba --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_display.py @@ -0,0 +1,288 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_axis_name_display import PublisherDocumentAxisNameDisplay + from gooddata_api_client.model.publisher_document_axis_values_display import PublisherDocumentAxisValuesDisplay + globals()['PublisherDocumentAxisNameDisplay'] = PublisherDocumentAxisNameDisplay + globals()['PublisherDocumentAxisValuesDisplay'] = PublisherDocumentAxisValuesDisplay + + +class PublisherDocumentAxisDisplay(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 { + 'max': (float,), # noqa: E501 + 'min': (float,), # noqa: E501 + 'name': (PublisherDocumentAxisNameDisplay,), # noqa: E501 + 'values': (PublisherDocumentAxisValuesDisplay,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'max': 'max', # noqa: E501 + 'min': 'min', # noqa: E501 + 'name': 'name', # noqa: E501 + 'values': 'values', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAxisDisplay - 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,) + max (float): [optional] # noqa: E501 + min (float): [optional] # noqa: E501 + name (PublisherDocumentAxisNameDisplay): [optional] # noqa: E501 + values (PublisherDocumentAxisValuesDisplay): [optional] # noqa: E501 + visible (bool): [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 + """PublisherDocumentAxisDisplay - 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,) + max (float): [optional] # noqa: E501 + min (float): [optional] # noqa: E501 + name (PublisherDocumentAxisNameDisplay): [optional] # noqa: E501 + values (PublisherDocumentAxisValuesDisplay): [optional] # noqa: E501 + visible (bool): [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/publisher_document_axis_name_display.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_name_display.py new file mode 100644 index 000000000..04e801cc3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_name_display.py @@ -0,0 +1,273 @@ +""" + 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 PublisherDocumentAxisNameDisplay(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 = { + ('position',): { + 'LOW': "low", + 'MIDDLE': "middle", + 'HIGH': "high", + }, + } + + 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 { + 'position': (str,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'position': 'position', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAxisNameDisplay - 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,) + position (str): [optional] # noqa: E501 + visible (bool): [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 + """PublisherDocumentAxisNameDisplay - 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,) + position (str): [optional] # noqa: E501 + visible (bool): [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/publisher_document_axis_values_display.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_values_display.py new file mode 100644 index 000000000..376435fc0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_axis_values_display.py @@ -0,0 +1,272 @@ +""" + 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 PublisherDocumentAxisValuesDisplay(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 = { + ('rotation',): { + 'inclusive_maximum': 90, + 'inclusive_minimum': -90, + }, + } + + @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 { + 'rotation': (float,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'rotation': 'rotation', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentAxisValuesDisplay - 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,) + rotation (float): Label rotation in degrees, from -90 to 90.. [optional] # noqa: E501 + visible (bool): [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 + """PublisherDocumentAxisValuesDisplay - 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,) + rotation (float): Label rotation in degrees, from -90 to 90.. [optional] # noqa: E501 + visible (bool): [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/publisher_document_bounded_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_bounded_filter.py new file mode 100644 index 000000000..91f45216a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_bounded_filter.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 + + + +class PublisherDocumentBoundedFilter(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': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'granularity': (str,), # noqa: E501 + '_from': (int,), # noqa: E501 + 'to': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'granularity': 'granularity', # noqa: E501 + '_from': 'from', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, granularity, *args, **kwargs): # noqa: E501 + """PublisherDocumentBoundedFilter - a model defined in OpenAPI + + Args: + granularity (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,) + _from (int): [optional] # noqa: E501 + to (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.granularity = granularity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, granularity, *args, **kwargs): # noqa: E501 + """PublisherDocumentBoundedFilter - a model defined in OpenAPI + + Args: + granularity (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,) + _from (int): [optional] # noqa: E501 + to (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.granularity = granularity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_chart_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_chart_style.py new file mode 100644 index 000000000..0808823f5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_chart_style.py @@ -0,0 +1,327 @@ +""" + 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 PublisherDocumentChartStyle(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 = { + ('axis_name_size',): { + 'inclusive_minimum': 0, + }, + ('axis_value_size',): { + 'inclusive_minimum': 0, + }, + ('data_label_size',): { + 'inclusive_minimum': 0, + }, + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('legend_size',): { + 'inclusive_minimum': 0, + }, + } + + @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 { + 'axis_line_color': (str,), # noqa: E501 + 'axis_name_color': (str,), # noqa: E501 + 'axis_name_size': (float,), # noqa: E501 + 'axis_value_color': (str,), # noqa: E501 + 'axis_value_size': (float,), # noqa: E501 + 'data_label_color': (str,), # noqa: E501 + 'data_label_size': (float,), # noqa: E501 + 'font_size': (float,), # noqa: E501 + 'grid_color': (str,), # noqa: E501 + 'legend_color': (str,), # noqa: E501 + 'legend_size': (float,), # noqa: E501 + 'plot_line_color': (str,), # noqa: E501 + 'text_color': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'axis_line_color': 'axisLineColor', # noqa: E501 + 'axis_name_color': 'axisNameColor', # noqa: E501 + 'axis_name_size': 'axisNameSize', # noqa: E501 + 'axis_value_color': 'axisValueColor', # noqa: E501 + 'axis_value_size': 'axisValueSize', # noqa: E501 + 'data_label_color': 'dataLabelColor', # noqa: E501 + 'data_label_size': 'dataLabelSize', # noqa: E501 + 'font_size': 'fontSize', # noqa: E501 + 'grid_color': 'gridColor', # noqa: E501 + 'legend_color': 'legendColor', # noqa: E501 + 'legend_size': 'legendSize', # noqa: E501 + 'plot_line_color': 'plotLineColor', # noqa: E501 + 'text_color': 'textColor', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentChartStyle - 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,) + axis_line_color (str): [optional] # noqa: E501 + axis_name_color (str): [optional] # noqa: E501 + axis_name_size (float): [optional] # noqa: E501 + axis_value_color (str): [optional] # noqa: E501 + axis_value_size (float): [optional] # noqa: E501 + data_label_color (str): [optional] # noqa: E501 + data_label_size (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + grid_color (str): [optional] # noqa: E501 + legend_color (str): [optional] # noqa: E501 + legend_size (float): [optional] # noqa: E501 + plot_line_color (str): [optional] # noqa: E501 + text_color (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__,) + + 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 + """PublisherDocumentChartStyle - 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,) + axis_line_color (str): [optional] # noqa: E501 + axis_name_color (str): [optional] # noqa: E501 + axis_name_size (float): [optional] # noqa: E501 + axis_value_color (str): [optional] # noqa: E501 + axis_value_size (float): [optional] # noqa: E501 + data_label_color (str): [optional] # noqa: E501 + data_label_size (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + grid_color (str): [optional] # noqa: E501 + legend_color (str): [optional] # noqa: E501 + legend_size (float): [optional] # noqa: E501 + plot_line_color (str): [optional] # noqa: E501 + text_color (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__,) + + 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/publisher_document_column.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_column.py new file mode 100644 index 000000000..fb39e1fd0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_column.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.publisher_document_container_style import PublisherDocumentContainerStyle + from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode + globals()['PublisherDocumentContainerStyle'] = PublisherDocumentContainerStyle + globals()['PublisherDocumentLayoutNode'] = PublisherDocumentLayoutNode + + +class PublisherDocumentColumn(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',): { + 'COLUMN': "column", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 { + 'children': ([PublisherDocumentLayoutNode],), # noqa: E501 + 'type': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentContainerStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'children': 'children', # noqa: E501 + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, children, *args, **kwargs): # noqa: E501 + """PublisherDocumentColumn - a model defined in OpenAPI + + Args: + children ([PublisherDocumentLayoutNode]): Child nodes from top to bottom, in reading order; an empty list is a spacer. + + 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. + 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): [optional] # noqa: E501 + locked (bool): Locks the container in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): Share of the parent's main axis, greater than 0. Default 1.. [optional] # noqa: E501 + style (PublisherDocumentContainerStyle): [optional] # noqa: E501 + """ + + 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', ()) + _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.children = children + 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, children, *args, **kwargs): # noqa: E501 + """PublisherDocumentColumn - a model defined in OpenAPI + + Args: + children ([PublisherDocumentLayoutNode]): Child nodes from top to bottom, in reading order; an empty list is a spacer. + + 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. + 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): [optional] # noqa: E501 + locked (bool): Locks the container in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): Share of the parent's main axis, greater than 0. Default 1.. [optional] # noqa: E501 + style (PublisherDocumentContainerStyle): [optional] # noqa: E501 + """ + + 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', ()) + _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.children = children + 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/publisher_document_comparison_condition.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_comparison_condition.py new file mode 100644 index 000000000..a45c56f92 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_comparison_condition.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.dashboard_compound_comparison_condition_comparison import DashboardCompoundComparisonConditionComparison + globals()['DashboardCompoundComparisonConditionComparison'] = DashboardCompoundComparisonConditionComparison + + +class PublisherDocumentComparisonCondition(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 { + 'comparison': (DashboardCompoundComparisonConditionComparison,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'comparison': 'comparison', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, comparison, *args, **kwargs): # noqa: E501 + """PublisherDocumentComparisonCondition - a model defined in OpenAPI + + Args: + comparison (DashboardCompoundComparisonConditionComparison): + + 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.comparison = comparison + 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, comparison, *args, **kwargs): # noqa: E501 + """PublisherDocumentComparisonCondition - a model defined in OpenAPI + + Args: + comparison (DashboardCompoundComparisonConditionComparison): + + 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.comparison = comparison + 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/publisher_document_container_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style.py new file mode 100644 index 000000000..7a8148a2e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style.py @@ -0,0 +1,638 @@ +""" + 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.publisher_document_area_style_gap import PublisherDocumentAreaStyleGap + from gooddata_api_client.model.publisher_document_container_style_border_bottom_left_radius import PublisherDocumentContainerStyleBorderBottomLeftRadius + from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding + globals()['PublisherDocumentAreaStyleGap'] = PublisherDocumentAreaStyleGap + globals()['PublisherDocumentContainerStyleBorderBottomLeftRadius'] = PublisherDocumentContainerStyleBorderBottomLeftRadius + globals()['PublisherDocumentContainerStylePadding'] = PublisherDocumentContainerStylePadding + + +class PublisherDocumentContainerStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + ('border_bottom_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_left_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_right_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_top_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('font_style',): { + 'NORMAL': "normal", + 'ITALIC': "italic", + }, + ('horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + 'JUSTIFY': "justify", + }, + ('text_overflow',): { + 'SHRINK': "shrink", + 'CLIP': "clip", + 'ELLIPSIS': "ellipsis", + }, + ('text_style',): { + 'TITLE': "title", + 'H1': "h1", + 'H2': "h2", + 'H3': "h3", + 'H4': "h4", + 'H5': "h5", + 'H6': "h6", + 'LARGETEXT': "largeText", + 'NORMALTEXT': "normalText", + 'SMALLTEXT': "smallText", + }, + ('text_transform',): { + 'NONE': "none", + 'UPPERCASE': "uppercase", + 'LOWERCASE': "lowercase", + 'CAPITALIZE': "capitalize", + }, + ('vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('border_bottom_width',): { + 'inclusive_minimum': 0, + }, + ('border_left_width',): { + 'inclusive_minimum': 0, + }, + ('border_right_width',): { + 'inclusive_minimum': 0, + }, + ('border_top_width',): { + 'inclusive_minimum': 0, + }, + ('border_width',): { + 'inclusive_minimum': 0, + }, + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('font_weight',): { + 'inclusive_maximum': 1000, + 'inclusive_minimum': 1, + }, + ('opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('shadow_blur',): { + 'inclusive_minimum': 0, + }, + ('shadow_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + } + + @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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'border_bottom_color': (str,), # noqa: E501 + 'border_bottom_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_style': (str,), # noqa: E501 + 'border_bottom_width': (float,), # noqa: E501 + 'border_color': (str,), # noqa: E501 + 'border_left_color': (str,), # noqa: E501 + 'border_left_style': (str,), # noqa: E501 + 'border_left_width': (float,), # noqa: E501 + 'border_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_right_color': (str,), # noqa: E501 + 'border_right_style': (str,), # noqa: E501 + 'border_right_width': (float,), # noqa: E501 + 'border_style': (str,), # noqa: E501 + 'border_top_color': (str,), # noqa: E501 + 'border_top_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_style': (str,), # noqa: E501 + 'border_top_width': (float,), # noqa: E501 + 'border_width': (float,), # noqa: E501 + 'font_size': (float,), # noqa: E501 + 'font_style': (str,), # noqa: E501 + 'font_weight': (float,), # noqa: E501 + 'gap': (PublisherDocumentAreaStyleGap,), # noqa: E501 + 'horizontal_align': (str,), # noqa: E501 + 'letter_spacing': (float,), # noqa: E501 + 'line_height': (float,), # noqa: E501 + 'opacity': (float,), # noqa: E501 + 'padding': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_bottom': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_left': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_right': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_top': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'shadow': (str,), # noqa: E501 + 'shadow_blur': (float,), # noqa: E501 + 'shadow_color': (str,), # noqa: E501 + 'shadow_opacity': (float,), # noqa: E501 + 'shadow_spread': (float,), # noqa: E501 + 'shadow_x': (float,), # noqa: E501 + 'shadow_y': (float,), # noqa: E501 + 'text_color': (str,), # noqa: E501 + 'text_overflow': (str,), # noqa: E501 + 'text_style': (str,), # noqa: E501 + 'text_transform': (str,), # noqa: E501 + 'vertical_align': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'border_bottom_color': 'borderBottomColor', # noqa: E501 + 'border_bottom_left_radius': 'borderBottomLeftRadius', # noqa: E501 + 'border_bottom_right_radius': 'borderBottomRightRadius', # noqa: E501 + 'border_bottom_style': 'borderBottomStyle', # noqa: E501 + 'border_bottom_width': 'borderBottomWidth', # noqa: E501 + 'border_color': 'borderColor', # noqa: E501 + 'border_left_color': 'borderLeftColor', # noqa: E501 + 'border_left_style': 'borderLeftStyle', # noqa: E501 + 'border_left_width': 'borderLeftWidth', # noqa: E501 + 'border_radius': 'borderRadius', # noqa: E501 + 'border_right_color': 'borderRightColor', # noqa: E501 + 'border_right_style': 'borderRightStyle', # noqa: E501 + 'border_right_width': 'borderRightWidth', # noqa: E501 + 'border_style': 'borderStyle', # noqa: E501 + 'border_top_color': 'borderTopColor', # noqa: E501 + 'border_top_left_radius': 'borderTopLeftRadius', # noqa: E501 + 'border_top_right_radius': 'borderTopRightRadius', # noqa: E501 + 'border_top_style': 'borderTopStyle', # noqa: E501 + 'border_top_width': 'borderTopWidth', # noqa: E501 + 'border_width': 'borderWidth', # noqa: E501 + 'font_size': 'fontSize', # noqa: E501 + 'font_style': 'fontStyle', # noqa: E501 + 'font_weight': 'fontWeight', # noqa: E501 + 'gap': 'gap', # noqa: E501 + 'horizontal_align': 'horizontalAlign', # noqa: E501 + 'letter_spacing': 'letterSpacing', # noqa: E501 + 'line_height': 'lineHeight', # noqa: E501 + 'opacity': 'opacity', # noqa: E501 + 'padding': 'padding', # noqa: E501 + 'padding_bottom': 'paddingBottom', # noqa: E501 + 'padding_left': 'paddingLeft', # noqa: E501 + 'padding_right': 'paddingRight', # noqa: E501 + 'padding_top': 'paddingTop', # noqa: E501 + 'shadow': 'shadow', # noqa: E501 + 'shadow_blur': 'shadowBlur', # noqa: E501 + 'shadow_color': 'shadowColor', # noqa: E501 + 'shadow_opacity': 'shadowOpacity', # noqa: E501 + 'shadow_spread': 'shadowSpread', # noqa: E501 + 'shadow_x': 'shadowX', # noqa: E501 + 'shadow_y': 'shadowY', # noqa: E501 + 'text_color': 'textColor', # noqa: E501 + 'text_overflow': 'textOverflow', # noqa: E501 + 'text_style': 'textStyle', # noqa: E501 + 'text_transform': 'textTransform', # noqa: E501 + 'vertical_align': 'verticalAlign', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentContainerStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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 + """PublisherDocumentContainerStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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/publisher_document_container_style_border_bottom_left_radius.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style_border_bottom_left_radius.py new file mode 100644 index 000000000..fc327adac --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style_border_bottom_left_radius.py @@ -0,0 +1,260 @@ +""" + 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 PublisherDocumentContainerStyleBorderBottomLeftRadius(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 { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentContainerStyleBorderBottomLeftRadius - 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,) + """ + + _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 + """PublisherDocumentContainerStyleBorderBottomLeftRadius - 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,) + """ + + _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/publisher_document_container_style_padding.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style_padding.py new file mode 100644 index 000000000..d5611e5a9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_container_style_padding.py @@ -0,0 +1,260 @@ +""" + 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 PublisherDocumentContainerStylePadding(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 { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentContainerStylePadding - 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,) + """ + + _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 + """PublisherDocumentContainerStylePadding - 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,) + """ + + _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/publisher_document_content.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_content.py new file mode 100644 index 000000000..e7d1a3038 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_content.py @@ -0,0 +1,308 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_area_style import PublisherDocumentAreaStyle + from gooddata_api_client.model.publisher_document_attribute_filter_config import PublisherDocumentAttributeFilterConfig + from gooddata_api_client.model.publisher_document_defaults import PublisherDocumentDefaults + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_page import PublisherDocumentPage + from gooddata_api_client.model.publisher_document_section import PublisherDocumentSection + globals()['PublisherDocumentAreaStyle'] = PublisherDocumentAreaStyle + globals()['PublisherDocumentAttributeFilterConfig'] = PublisherDocumentAttributeFilterConfig + globals()['PublisherDocumentDefaults'] = PublisherDocumentDefaults + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentPage'] = PublisherDocumentPage + globals()['PublisherDocumentSection'] = PublisherDocumentSection + + +class PublisherDocumentContent(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 { + 'attribute_filter_configs': ([PublisherDocumentAttributeFilterConfig],), # noqa: E501 + 'defaults': (PublisherDocumentDefaults,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'format_locale': (str,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'pages': ([PublisherDocumentPage],), # noqa: E501 + 'sections': ([PublisherDocumentSection],), # noqa: E501 + 'style': (PublisherDocumentAreaStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_filter_configs': 'attributeFilterConfigs', # noqa: E501 + 'defaults': 'defaults', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'format_locale': 'formatLocale', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'pages': 'pages', # noqa: E501 + 'sections': 'sections', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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 + """PublisherDocumentContent - 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,) + attribute_filter_configs ([PublisherDocumentAttributeFilterConfig]): [optional] # noqa: E501 + defaults (PublisherDocumentDefaults): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Document filters, at most one per attribute display form or date dataset.. [optional] # noqa: E501 + format_locale (str): Locale for formatting dates in variables, charts and tables.. [optional] # noqa: E501 + locale (str): Locale of the text the product writes, such as `de-DE`.. [optional] # noqa: E501 + pages ([PublisherDocumentPage]): The document's pages, when it has no sections.. [optional] # noqa: E501 + sections ([PublisherDocumentSection]): Groups of pages, when the document has no top-level pages.. [optional] # noqa: E501 + style (PublisherDocumentAreaStyle): [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/publisher_document_data_set_ref.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_data_set_ref.py new file mode 100644 index 000000000..7236a08e6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_data_set_ref.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 PublisherDocumentDataSetRef(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',): { + 'DATASET': "dataSet", + }, + } + + 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 { + 'identifier': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'identifier': 'identifier', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentDataSetRef - a model defined in OpenAPI + + Args: + identifier (str): + + Keyword Args: + type (str): defaults to "dataSet", must be one of ["dataSet", ] # 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', "dataSet") + _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.identifier = identifier + 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, identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentDataSetRef - a model defined in OpenAPI + + Args: + identifier (str): + + Keyword Args: + type (str): defaults to "dataSet", must be one of ["dataSet", ] # 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', "dataSet") + _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.identifier = identifier + 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/publisher_document_date_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter.py new file mode 100644 index 000000000..9c730b999 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_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.publisher_document_date_filter_date_filter import PublisherDocumentDateFilterDateFilter + globals()['PublisherDocumentDateFilterDateFilter'] = PublisherDocumentDateFilterDateFilter + + +class PublisherDocumentDateFilter(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 { + 'date_filter': (PublisherDocumentDateFilterDateFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'date_filter': 'dateFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, date_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilter - a model defined in OpenAPI + + Args: + date_filter (PublisherDocumentDateFilterDateFilter): + + 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.date_filter = 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, date_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilter - a model defined in OpenAPI + + Args: + date_filter (PublisherDocumentDateFilterDateFilter): + + 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.date_filter = 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/publisher_document_date_filter_date_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_date_filter.py new file mode 100644 index 000000000..ff68a9525 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_date_filter.py @@ -0,0 +1,341 @@ +""" + 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.publisher_document_bounded_filter import PublisherDocumentBoundedFilter + from gooddata_api_client.model.publisher_document_date_filter_date_filter_from import PublisherDocumentDateFilterDateFilterFrom + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentBoundedFilter'] = PublisherDocumentBoundedFilter + globals()['PublisherDocumentDateFilterDateFilterFrom'] = PublisherDocumentDateFilterDateFilterFrom + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentDateFilterDateFilter(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': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + ('type',): { + 'RELATIVE': "relative", + 'ABSOLUTE': "absolute", + }, + ('empty_value_handling',): { + 'INCLUDE': "include", + 'EXCLUDE': "exclude", + 'ONLY': "only", + }, + } + + validations = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'granularity': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'attribute': (PublisherDocumentObjRef,), # noqa: E501 + 'bounded_filter': (PublisherDocumentBoundedFilter,), # noqa: E501 + 'data_set': (PublisherDocumentObjRef,), # noqa: E501 + 'empty_value_handling': (str,), # noqa: E501 + '_from': (PublisherDocumentDateFilterDateFilterFrom,), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + 'to': (PublisherDocumentDateFilterDateFilterFrom,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'granularity': 'granularity', # noqa: E501 + 'type': 'type', # noqa: E501 + 'attribute': 'attribute', # noqa: E501 + 'bounded_filter': 'boundedFilter', # noqa: E501 + 'data_set': 'dataSet', # 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, granularity, type, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilterDateFilter - a model defined in OpenAPI + + Args: + granularity (str): + type (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,) + attribute (PublisherDocumentObjRef): [optional] # noqa: E501 + bounded_filter (PublisherDocumentBoundedFilter): [optional] # noqa: E501 + data_set (PublisherDocumentObjRef): [optional] # noqa: E501 + empty_value_handling (str): [optional] # noqa: E501 + _from (PublisherDocumentDateFilterDateFilterFrom): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + to (PublisherDocumentDateFilterDateFilterFrom): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.granularity = granularity + 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, granularity, type, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilterDateFilter - a model defined in OpenAPI + + Args: + granularity (str): + type (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,) + attribute (PublisherDocumentObjRef): [optional] # noqa: E501 + bounded_filter (PublisherDocumentBoundedFilter): [optional] # noqa: E501 + data_set (PublisherDocumentObjRef): [optional] # noqa: E501 + empty_value_handling (str): [optional] # noqa: E501 + _from (PublisherDocumentDateFilterDateFilterFrom): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + to (PublisherDocumentDateFilterDateFilterFrom): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.granularity = granularity + 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/publisher_document_date_filter_date_filter_from.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_date_filter_from.py new file mode 100644 index 000000000..1b234dff2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_date_filter_from.py @@ -0,0 +1,260 @@ +""" + 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 PublisherDocumentDateFilterDateFilterFrom(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 { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilterDateFilterFrom - 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,) + """ + + _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 + """PublisherDocumentDateFilterDateFilterFrom - 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,) + """ + + _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/publisher_document_date_filter_reference.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_reference.py new file mode 100644 index 000000000..95cf5d837 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_date_filter_reference.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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentDateFilterReference(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',): { + 'DATEFILTERREFERENCE': "dateFilterReference", + }, + } + + 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_set': (PublisherDocumentObjRef,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_set': 'dataSet', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, data_set, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilterReference - a model defined in OpenAPI + + Args: + data_set (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "dateFilterReference", must be one of ["dateFilterReference", ] # 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', "dateFilterReference") + _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_set = data_set + 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, data_set, *args, **kwargs): # noqa: E501 + """PublisherDocumentDateFilterReference - a model defined in OpenAPI + + Args: + data_set (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "dateFilterReference", must be one of ["dateFilterReference", ] # 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', "dateFilterReference") + _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_set = data_set + 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/publisher_document_defaults.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_defaults.py new file mode 100644 index 000000000..dd0c2fa81 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_defaults.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.publisher_document_period import PublisherDocumentPeriod + from gooddata_api_client.model.publisher_document_takeaway_defaults import PublisherDocumentTakeawayDefaults + globals()['PublisherDocumentPeriod'] = PublisherDocumentPeriod + globals()['PublisherDocumentTakeawayDefaults'] = PublisherDocumentTakeawayDefaults + + +class PublisherDocumentDefaults(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 = { + ('page_size',): { + 'WIDESCREEN': "widescreen", + }, + } + + 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 { + 'page_size': (str,), # noqa: E501 + 'period': (PublisherDocumentPeriod,), # noqa: E501 + 'takeaway': (PublisherDocumentTakeawayDefaults,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'page_size': 'pageSize', # noqa: E501 + 'period': 'period', # noqa: E501 + 'takeaway': 'takeaway', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentDefaults - 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,) + page_size (str): Page size of a page that sets none.. [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + period (PublisherDocumentPeriod): [optional] # noqa: E501 + takeaway (PublisherDocumentTakeawayDefaults): [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 + """PublisherDocumentDefaults - 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,) + page_size (str): Page size of a page that sets none.. [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + period (PublisherDocumentPeriod): [optional] # noqa: E501 + takeaway (PublisherDocumentTakeawayDefaults): [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/publisher_document_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_filter.py new file mode 100644 index 000000000..b5a344c89 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_filter.py @@ -0,0 +1,358 @@ +""" + 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.publisher_document_arbitrary_attribute_filter import PublisherDocumentArbitraryAttributeFilter + from gooddata_api_client.model.publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter import PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter + from gooddata_api_client.model.publisher_document_attribute_filter import PublisherDocumentAttributeFilter + from gooddata_api_client.model.publisher_document_attribute_filter_attribute_filter import PublisherDocumentAttributeFilterAttributeFilter + from gooddata_api_client.model.publisher_document_date_filter import PublisherDocumentDateFilter + from gooddata_api_client.model.publisher_document_date_filter_date_filter import PublisherDocumentDateFilterDateFilter + from gooddata_api_client.model.publisher_document_match_attribute_filter import PublisherDocumentMatchAttributeFilter + from gooddata_api_client.model.publisher_document_match_attribute_filter_match_attribute_filter import PublisherDocumentMatchAttributeFilterMatchAttributeFilter + from gooddata_api_client.model.publisher_document_measure_value_filter import PublisherDocumentMeasureValueFilter + from gooddata_api_client.model.publisher_document_measure_value_filter_dashboard_measure_value_filter import PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter + globals()['PublisherDocumentArbitraryAttributeFilter'] = PublisherDocumentArbitraryAttributeFilter + globals()['PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter'] = PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter + globals()['PublisherDocumentAttributeFilter'] = PublisherDocumentAttributeFilter + globals()['PublisherDocumentAttributeFilterAttributeFilter'] = PublisherDocumentAttributeFilterAttributeFilter + globals()['PublisherDocumentDateFilter'] = PublisherDocumentDateFilter + globals()['PublisherDocumentDateFilterDateFilter'] = PublisherDocumentDateFilterDateFilter + globals()['PublisherDocumentMatchAttributeFilter'] = PublisherDocumentMatchAttributeFilter + globals()['PublisherDocumentMatchAttributeFilterMatchAttributeFilter'] = PublisherDocumentMatchAttributeFilterMatchAttributeFilter + globals()['PublisherDocumentMeasureValueFilter'] = PublisherDocumentMeasureValueFilter + globals()['PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter'] = PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter + + +class PublisherDocumentFilter(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 { + 'attribute_filter': (PublisherDocumentAttributeFilterAttributeFilter,), # noqa: E501 + 'arbitrary_attribute_filter': (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter,), # noqa: E501 + 'match_attribute_filter': (PublisherDocumentMatchAttributeFilterMatchAttributeFilter,), # noqa: E501 + 'date_filter': (PublisherDocumentDateFilterDateFilter,), # noqa: E501 + 'dashboard_measure_value_filter': (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_filter': 'attributeFilter', # noqa: E501 + 'arbitrary_attribute_filter': 'arbitraryAttributeFilter', # noqa: E501 + 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 + 'date_filter': 'dateFilter', # noqa: E501 + 'dashboard_measure_value_filter': 'dashboardMeasureValueFilter', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentFilter - 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,) + attribute_filter (PublisherDocumentAttributeFilterAttributeFilter): [optional] # noqa: E501 + arbitrary_attribute_filter (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter): [optional] # noqa: E501 + match_attribute_filter (PublisherDocumentMatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 + date_filter (PublisherDocumentDateFilterDateFilter): [optional] # noqa: E501 + dashboard_measure_value_filter (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter): [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 + """PublisherDocumentFilter - 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,) + attribute_filter (PublisherDocumentAttributeFilterAttributeFilter): [optional] # noqa: E501 + arbitrary_attribute_filter (PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter): [optional] # noqa: E501 + match_attribute_filter (PublisherDocumentMatchAttributeFilterMatchAttributeFilter): [optional] # noqa: E501 + date_filter (PublisherDocumentDateFilterDateFilter): [optional] # noqa: E501 + dashboard_measure_value_filter (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter): [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': [ + PublisherDocumentArbitraryAttributeFilter, + PublisherDocumentAttributeFilter, + PublisherDocumentDateFilter, + PublisherDocumentMatchAttributeFilter, + PublisherDocumentMeasureValueFilter, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_filter_reference.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_filter_reference.py new file mode 100644 index 000000000..71a90cd20 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_filter_reference.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.publisher_document_attribute_filter_reference import PublisherDocumentAttributeFilterReference + from gooddata_api_client.model.publisher_document_date_filter_reference import PublisherDocumentDateFilterReference + from gooddata_api_client.model.publisher_document_measure_value_filter_reference import PublisherDocumentMeasureValueFilterReference + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentAttributeFilterReference'] = PublisherDocumentAttributeFilterReference + globals()['PublisherDocumentDateFilterReference'] = PublisherDocumentDateFilterReference + globals()['PublisherDocumentMeasureValueFilterReference'] = PublisherDocumentMeasureValueFilterReference + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentFilterReference(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',): { + 'MEASUREVALUEFILTERREFERENCE': "measureValueFilterReference", + }, + } + + 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 + 'display_form': (PublisherDocumentObjRef,), # noqa: E501 + 'data_set': (PublisherDocumentObjRef,), # noqa: E501 + 'measure': (PublisherDocumentObjRef,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'PublisherDocumentAttributeFilterReference': PublisherDocumentAttributeFilterReference, + 'PublisherDocumentDateFilterReference': PublisherDocumentDateFilterReference, + 'PublisherDocumentMeasureValueFilterReference': PublisherDocumentMeasureValueFilterReference, + 'attributeFilterReference': PublisherDocumentAttributeFilterReference, + 'dateFilterReference': PublisherDocumentDateFilterReference, + 'measureValueFilterReference': PublisherDocumentMeasureValueFilterReference, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'type': 'type', # noqa: E501 + 'display_form': 'displayForm', # noqa: E501 + 'data_set': 'dataSet', # 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 + """PublisherDocumentFilterReference - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "measureValueFilterReference", must be one of ["measureValueFilterReference", ] # 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,) + display_form (PublisherDocumentObjRef): [optional] # noqa: E501 + data_set (PublisherDocumentObjRef): [optional] # noqa: E501 + measure (PublisherDocumentObjRef): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "measureValueFilterReference") + _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 + """PublisherDocumentFilterReference - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "measureValueFilterReference", must be one of ["measureValueFilterReference", ] # 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,) + display_form (PublisherDocumentObjRef): [optional] # noqa: E501 + data_set (PublisherDocumentObjRef): [optional] # noqa: E501 + measure (PublisherDocumentObjRef): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "measureValueFilterReference") + _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': [ + PublisherDocumentAttributeFilterReference, + PublisherDocumentDateFilterReference, + PublisherDocumentMeasureValueFilterReference, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_heading_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_heading_widget.py new file mode 100644 index 000000000..417028909 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_heading_widget.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.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentTextWidgetStyle'] = PublisherDocumentTextWidgetStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + + +class PublisherDocumentHeadingWidget(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',): { + 'HEADING': "heading", + }, + ('level',): { + '1': 1, + '2': 2, + '3': 3, + '4': 4, + '5': 5, + '6': 6, + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'level': (int,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'markdown': (str,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentTextWidgetStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'level': 'level', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'markdown': 'markdown', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentHeadingWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "heading", must be one of ["heading", ] # 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,) + level (int): Outline level below the page title. Default 1.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Inline markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "heading") + _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 + """PublisherDocumentHeadingWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "heading", must be one of ["heading", ] # 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,) + level (int): Outline level below the page title. Default 1.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Inline markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "heading") + _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/publisher_document_headline_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_headline_style.py new file mode 100644 index 000000000..8fb4b207b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_headline_style.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 + + + +class PublisherDocumentHeadlineStyle(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 = { + ('primary_value_size',): { + 'inclusive_minimum': 0, + }, + ('secondary_value_size',): { + 'inclusive_minimum': 0, + }, + } + + @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 { + 'negative_color': (str,), # noqa: E501 + 'positive_color': (str,), # noqa: E501 + 'primary_value_color': (str,), # noqa: E501 + 'primary_value_size': (float,), # noqa: E501 + 'secondary_value_color': (str,), # noqa: E501 + 'secondary_value_size': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'negative_color': 'negativeColor', # noqa: E501 + 'positive_color': 'positiveColor', # noqa: E501 + 'primary_value_color': 'primaryValueColor', # noqa: E501 + 'primary_value_size': 'primaryValueSize', # noqa: E501 + 'secondary_value_color': 'secondaryValueColor', # noqa: E501 + 'secondary_value_size': 'secondaryValueSize', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentHeadlineStyle - 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,) + negative_color (str): [optional] # noqa: E501 + positive_color (str): [optional] # noqa: E501 + primary_value_color (str): [optional] # noqa: E501 + primary_value_size (float): [optional] # noqa: E501 + secondary_value_color (str): [optional] # noqa: E501 + secondary_value_size (float): [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 + """PublisherDocumentHeadlineStyle - 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,) + negative_color (str): [optional] # noqa: E501 + positive_color (str): [optional] # noqa: E501 + primary_value_color (str): [optional] # noqa: E501 + primary_value_size (float): [optional] # noqa: E501 + secondary_value_color (str): [optional] # noqa: E501 + secondary_value_size (float): [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/publisher_document_image_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_image_widget.py new file mode 100644 index 000000000..3491d10af --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_image_widget.py @@ -0,0 +1,325 @@ +""" + 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.publisher_document_image_widget_style import PublisherDocumentImageWidgetStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentImageWidgetStyle'] = PublisherDocumentImageWidgetStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + + +class PublisherDocumentImageWidget(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',): { + 'IMAGE': "image", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'alt_text': (str,), # noqa: E501 + 'decorative': (bool,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'style': (PublisherDocumentImageWidgetStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'alt_text': 'altText', # noqa: E501 + 'decorative': 'decorative', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'source': 'source', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentImageWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "image", must be one of ["image", ] # 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,) + alt_text (str): [optional] # noqa: E501 + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + source (str): A theme image reference such as `{theme.logo}`, or an `https://` URL.. [optional] # noqa: E501 + style (PublisherDocumentImageWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "image") + _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 + """PublisherDocumentImageWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "image", must be one of ["image", ] # 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,) + alt_text (str): [optional] # noqa: E501 + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + source (str): A theme image reference such as `{theme.logo}`, or an `https://` URL.. [optional] # noqa: E501 + style (PublisherDocumentImageWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "image") + _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/publisher_document_image_widget_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_image_widget_style.py new file mode 100644 index 000000000..65c5d9f1c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_image_widget_style.py @@ -0,0 +1,570 @@ +""" + 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.publisher_document_container_style_border_bottom_left_radius import PublisherDocumentContainerStyleBorderBottomLeftRadius + from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding + globals()['PublisherDocumentContainerStyleBorderBottomLeftRadius'] = PublisherDocumentContainerStyleBorderBottomLeftRadius + globals()['PublisherDocumentContainerStylePadding'] = PublisherDocumentContainerStylePadding + + +class PublisherDocumentImageWidgetStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + ('border_bottom_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_left_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_right_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_top_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('fit',): { + 'CONTAIN': "contain", + 'COVER': "cover", + 'FILL': "fill", + }, + ('horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('border_bottom_width',): { + 'inclusive_minimum': 0, + }, + ('border_left_width',): { + 'inclusive_minimum': 0, + }, + ('border_right_width',): { + 'inclusive_minimum': 0, + }, + ('border_top_width',): { + 'inclusive_minimum': 0, + }, + ('border_width',): { + 'inclusive_minimum': 0, + }, + ('opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('shadow_blur',): { + 'inclusive_minimum': 0, + }, + ('shadow_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + } + + @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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'border_bottom_color': (str,), # noqa: E501 + 'border_bottom_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_style': (str,), # noqa: E501 + 'border_bottom_width': (float,), # noqa: E501 + 'border_color': (str,), # noqa: E501 + 'border_left_color': (str,), # noqa: E501 + 'border_left_style': (str,), # noqa: E501 + 'border_left_width': (float,), # noqa: E501 + 'border_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_right_color': (str,), # noqa: E501 + 'border_right_style': (str,), # noqa: E501 + 'border_right_width': (float,), # noqa: E501 + 'border_style': (str,), # noqa: E501 + 'border_top_color': (str,), # noqa: E501 + 'border_top_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_style': (str,), # noqa: E501 + 'border_top_width': (float,), # noqa: E501 + 'border_width': (float,), # noqa: E501 + 'fit': (str,), # noqa: E501 + 'horizontal_align': (str,), # noqa: E501 + 'opacity': (float,), # noqa: E501 + 'padding': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_bottom': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_left': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_right': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_top': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'shadow': (str,), # noqa: E501 + 'shadow_blur': (float,), # noqa: E501 + 'shadow_color': (str,), # noqa: E501 + 'shadow_opacity': (float,), # noqa: E501 + 'shadow_spread': (float,), # noqa: E501 + 'shadow_x': (float,), # noqa: E501 + 'shadow_y': (float,), # noqa: E501 + 'vertical_align': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'border_bottom_color': 'borderBottomColor', # noqa: E501 + 'border_bottom_left_radius': 'borderBottomLeftRadius', # noqa: E501 + 'border_bottom_right_radius': 'borderBottomRightRadius', # noqa: E501 + 'border_bottom_style': 'borderBottomStyle', # noqa: E501 + 'border_bottom_width': 'borderBottomWidth', # noqa: E501 + 'border_color': 'borderColor', # noqa: E501 + 'border_left_color': 'borderLeftColor', # noqa: E501 + 'border_left_style': 'borderLeftStyle', # noqa: E501 + 'border_left_width': 'borderLeftWidth', # noqa: E501 + 'border_radius': 'borderRadius', # noqa: E501 + 'border_right_color': 'borderRightColor', # noqa: E501 + 'border_right_style': 'borderRightStyle', # noqa: E501 + 'border_right_width': 'borderRightWidth', # noqa: E501 + 'border_style': 'borderStyle', # noqa: E501 + 'border_top_color': 'borderTopColor', # noqa: E501 + 'border_top_left_radius': 'borderTopLeftRadius', # noqa: E501 + 'border_top_right_radius': 'borderTopRightRadius', # noqa: E501 + 'border_top_style': 'borderTopStyle', # noqa: E501 + 'border_top_width': 'borderTopWidth', # noqa: E501 + 'border_width': 'borderWidth', # noqa: E501 + 'fit': 'fit', # noqa: E501 + 'horizontal_align': 'horizontalAlign', # noqa: E501 + 'opacity': 'opacity', # noqa: E501 + 'padding': 'padding', # noqa: E501 + 'padding_bottom': 'paddingBottom', # noqa: E501 + 'padding_left': 'paddingLeft', # noqa: E501 + 'padding_right': 'paddingRight', # noqa: E501 + 'padding_top': 'paddingTop', # noqa: E501 + 'shadow': 'shadow', # noqa: E501 + 'shadow_blur': 'shadowBlur', # noqa: E501 + 'shadow_color': 'shadowColor', # noqa: E501 + 'shadow_opacity': 'shadowOpacity', # noqa: E501 + 'shadow_spread': 'shadowSpread', # noqa: E501 + 'shadow_x': 'shadowX', # noqa: E501 + 'shadow_y': 'shadowY', # noqa: E501 + 'vertical_align': 'verticalAlign', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentImageWidgetStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + fit (str): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + vertical_align (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__,) + + 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 + """PublisherDocumentImageWidgetStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + fit (str): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + vertical_align (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__,) + + 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/publisher_document_layout_node.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_layout_node.py new file mode 100644 index 000000000..dbcc8c256 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_layout_node.py @@ -0,0 +1,476 @@ +""" + 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.publisher_document_column import PublisherDocumentColumn + from gooddata_api_client.model.publisher_document_data_set_ref import PublisherDocumentDataSetRef + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_filter_reference import PublisherDocumentFilterReference + from gooddata_api_client.model.publisher_document_heading_widget import PublisherDocumentHeadingWidget + from gooddata_api_client.model.publisher_document_image_widget import PublisherDocumentImageWidget + from gooddata_api_client.model.publisher_document_row import PublisherDocumentRow + from gooddata_api_client.model.publisher_document_takeaway_generation import PublisherDocumentTakeawayGeneration + from gooddata_api_client.model.publisher_document_takeaway_widget import PublisherDocumentTakeawayWidget + from gooddata_api_client.model.publisher_document_text_widget import PublisherDocumentTextWidget + from gooddata_api_client.model.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle + from gooddata_api_client.model.publisher_document_title_widget import PublisherDocumentTitleWidget + from gooddata_api_client.model.publisher_document_visualization_display import PublisherDocumentVisualizationDisplay + from gooddata_api_client.model.publisher_document_visualization_ref import PublisherDocumentVisualizationRef + from gooddata_api_client.model.publisher_document_visualization_widget import PublisherDocumentVisualizationWidget + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + from gooddata_api_client.model.publisher_document_widget_title import PublisherDocumentWidgetTitle + globals()['PublisherDocumentColumn'] = PublisherDocumentColumn + globals()['PublisherDocumentDataSetRef'] = PublisherDocumentDataSetRef + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentFilterReference'] = PublisherDocumentFilterReference + globals()['PublisherDocumentHeadingWidget'] = PublisherDocumentHeadingWidget + globals()['PublisherDocumentImageWidget'] = PublisherDocumentImageWidget + globals()['PublisherDocumentRow'] = PublisherDocumentRow + globals()['PublisherDocumentTakeawayGeneration'] = PublisherDocumentTakeawayGeneration + globals()['PublisherDocumentTakeawayWidget'] = PublisherDocumentTakeawayWidget + globals()['PublisherDocumentTextWidget'] = PublisherDocumentTextWidget + globals()['PublisherDocumentTextWidgetStyle'] = PublisherDocumentTextWidgetStyle + globals()['PublisherDocumentTitleWidget'] = PublisherDocumentTitleWidget + globals()['PublisherDocumentVisualizationDisplay'] = PublisherDocumentVisualizationDisplay + globals()['PublisherDocumentVisualizationRef'] = PublisherDocumentVisualizationRef + globals()['PublisherDocumentVisualizationWidget'] = PublisherDocumentVisualizationWidget + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentWidgetTitle'] = PublisherDocumentWidgetTitle + + +class PublisherDocumentLayoutNode(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',): { + 'TAKEAWAY': "takeaway", + }, + ('level',): { + '1': 1, + '2': 2, + '3': 3, + '4': 4, + '5': 5, + '6': 6, + }, + } + + validations = { + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'type': (str,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentTextWidgetStyle,), # noqa: E501 + 'markdown': (str,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'level': (int,), # noqa: E501 + 'decorative': (bool,), # noqa: E501 + 'alt_text': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'date_data_set': (PublisherDocumentDataSetRef,), # noqa: E501 + 'display': (PublisherDocumentVisualizationDisplay,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'ignore_document_filters': ([PublisherDocumentFilterReference],), # noqa: E501 + 'ignore_document_period': (bool,), # noqa: E501 + 'title': (PublisherDocumentWidgetTitle,), # noqa: E501 + 'visualization': (PublisherDocumentVisualizationRef,), # noqa: E501 + 'generation': (PublisherDocumentTakeawayGeneration,), # noqa: E501 + 'children': ([PublisherDocumentLayoutNode],), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'PublisherDocumentColumn': PublisherDocumentColumn, + 'PublisherDocumentHeadingWidget': PublisherDocumentHeadingWidget, + 'PublisherDocumentImageWidget': PublisherDocumentImageWidget, + 'PublisherDocumentRow': PublisherDocumentRow, + 'PublisherDocumentTakeawayWidget': PublisherDocumentTakeawayWidget, + 'PublisherDocumentTextWidget': PublisherDocumentTextWidget, + 'PublisherDocumentTitleWidget': PublisherDocumentTitleWidget, + 'PublisherDocumentVisualizationWidget': PublisherDocumentVisualizationWidget, + 'column': PublisherDocumentColumn, + 'heading': PublisherDocumentHeadingWidget, + 'image': PublisherDocumentImageWidget, + 'row': PublisherDocumentRow, + 'takeaway': PublisherDocumentTakeawayWidget, + 'text': PublisherDocumentTextWidget, + 'title': PublisherDocumentTitleWidget, + 'visualization': PublisherDocumentVisualizationWidget, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'type': 'type', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + 'markdown': 'markdown', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'level': 'level', # noqa: E501 + 'decorative': 'decorative', # noqa: E501 + 'alt_text': 'altText', # noqa: E501 + 'source': 'source', # noqa: E501 + 'date_data_set': 'dateDataSet', # noqa: E501 + 'display': 'display', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'ignore_document_filters': 'ignoreDocumentFilters', # noqa: E501 + 'ignore_document_period': 'ignoreDocumentPeriod', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visualization': 'visualization', # noqa: E501 + 'generation': 'generation', # noqa: E501 + 'children': 'children', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentLayoutNode - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "takeaway", must be one of ["takeaway", ] # 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,) + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + markdown (str): The generated text.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + level (int): Outline level below the page title. Default 1.. [optional] # noqa: E501 + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.. [optional] # noqa: E501 + alt_text (str): Defaults to the visualization's description.. [optional] # noqa: E501 + source (str): A theme image reference such as `{theme.logo}`, or an `https://` URL.. [optional] # noqa: E501 + date_data_set (PublisherDocumentDataSetRef): [optional] # noqa: E501 + display (PublisherDocumentVisualizationDisplay): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Widget filters; stored, not applied.. [optional] # noqa: E501 + ignore_document_filters ([PublisherDocumentFilterReference]): Document filters this widget ignores.. [optional] # noqa: E501 + ignore_document_period (bool): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + visualization (PublisherDocumentVisualizationRef): [optional] # noqa: E501 + generation (PublisherDocumentTakeawayGeneration): [optional] # noqa: E501 + children ([PublisherDocumentLayoutNode]): Child nodes from top to bottom, in reading order; an empty list is a spacer.. [optional] # noqa: E501 + id (str): Unique within the page.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "takeaway") + _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 + """PublisherDocumentLayoutNode - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "takeaway", must be one of ["takeaway", ] # 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,) + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + markdown (str): The generated text.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + level (int): Outline level below the page title. Default 1.. [optional] # noqa: E501 + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.. [optional] # noqa: E501 + alt_text (str): Defaults to the visualization's description.. [optional] # noqa: E501 + source (str): A theme image reference such as `{theme.logo}`, or an `https://` URL.. [optional] # noqa: E501 + date_data_set (PublisherDocumentDataSetRef): [optional] # noqa: E501 + display (PublisherDocumentVisualizationDisplay): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Widget filters; stored, not applied.. [optional] # noqa: E501 + ignore_document_filters ([PublisherDocumentFilterReference]): Document filters this widget ignores.. [optional] # noqa: E501 + ignore_document_period (bool): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + visualization (PublisherDocumentVisualizationRef): [optional] # noqa: E501 + generation (PublisherDocumentTakeawayGeneration): [optional] # noqa: E501 + children ([PublisherDocumentLayoutNode]): Child nodes from top to bottom, in reading order; an empty list is a spacer.. [optional] # noqa: E501 + id (str): Unique within the page.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "takeaway") + _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': [ + PublisherDocumentColumn, + PublisherDocumentHeadingWidget, + PublisherDocumentImageWidget, + PublisherDocumentRow, + PublisherDocumentTakeawayWidget, + PublisherDocumentTextWidget, + PublisherDocumentTitleWidget, + PublisherDocumentVisualizationWidget, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_legend_display.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_legend_display.py new file mode 100644 index 000000000..5882f5dea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_legend_display.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 PublisherDocumentLegendDisplay(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 = { + ('position',): { + 'AUTO': "auto", + 'TOP': "top", + 'BOTTOM': "bottom", + 'LEFT': "left", + 'RIGHT': "right", + }, + } + + 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 { + 'position': (str,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'position': 'position', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentLegendDisplay - 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,) + position (str): [optional] # noqa: E501 + visible (bool): [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 + """PublisherDocumentLegendDisplay - 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,) + position (str): [optional] # noqa: E501 + visible (bool): [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/publisher_document_match_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_match_attribute_filter.py new file mode 100644 index 000000000..8014b2be4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_match_attribute_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.publisher_document_match_attribute_filter_match_attribute_filter import PublisherDocumentMatchAttributeFilterMatchAttributeFilter + globals()['PublisherDocumentMatchAttributeFilterMatchAttributeFilter'] = PublisherDocumentMatchAttributeFilterMatchAttributeFilter + + +class PublisherDocumentMatchAttributeFilter(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 { + 'match_attribute_filter': (PublisherDocumentMatchAttributeFilterMatchAttributeFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'match_attribute_filter': 'matchAttributeFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, match_attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentMatchAttributeFilter - a model defined in OpenAPI + + Args: + match_attribute_filter (PublisherDocumentMatchAttributeFilterMatchAttributeFilter): + + 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.match_attribute_filter = match_attribute_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, match_attribute_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentMatchAttributeFilter - a model defined in OpenAPI + + Args: + match_attribute_filter (PublisherDocumentMatchAttributeFilterMatchAttributeFilter): + + 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.match_attribute_filter = match_attribute_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/publisher_document_match_attribute_filter_match_attribute_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_match_attribute_filter_match_attribute_filter.py new file mode 100644 index 000000000..c4020a955 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_match_attribute_filter_match_attribute_filter.py @@ -0,0 +1,314 @@ +""" + 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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentMatchAttributeFilterMatchAttributeFilter(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',): { + 'CONTAINS': "contains", + 'STARTSWITH': "startsWith", + 'ENDSWITH': "endsWith", + }, + } + + validations = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'display_form': (PublisherDocumentObjRef,), # noqa: E501 + 'literal': (str,), # noqa: E501 + 'operator': (str,), # noqa: E501 + 'case_sensitive': (bool,), # noqa: E501 + 'local_identifier': (str,), # noqa: E501 + 'negative_selection': (bool,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'display_form': 'displayForm', # noqa: E501 + 'literal': 'literal', # noqa: E501 + 'operator': 'operator', # noqa: E501 + 'case_sensitive': 'caseSensitive', # noqa: E501 + 'local_identifier': 'localIdentifier', # noqa: E501 + 'negative_selection': 'negativeSelection', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, display_form, literal, operator, *args, **kwargs): # noqa: E501 + """PublisherDocumentMatchAttributeFilterMatchAttributeFilter - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + literal (str): + operator (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,) + case_sensitive (bool): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + negative_selection (bool): [optional] # noqa: E501 + 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.display_form = display_form + self.literal = literal + self.operator = operator + 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, display_form, literal, operator, *args, **kwargs): # noqa: E501 + """PublisherDocumentMatchAttributeFilterMatchAttributeFilter - a model defined in OpenAPI + + Args: + display_form (PublisherDocumentObjRef): + literal (str): + operator (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,) + case_sensitive (bool): [optional] # noqa: E501 + local_identifier (str): Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.. [optional] # noqa: E501 + negative_selection (bool): [optional] # noqa: E501 + 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.display_form = display_form + self.literal = literal + self.operator = operator + 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/publisher_document_measure_value_condition.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_condition.py new file mode 100644 index 000000000..95ca897bf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_condition.py @@ -0,0 +1,331 @@ +""" + 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.dashboard_compound_comparison_condition_comparison import DashboardCompoundComparisonConditionComparison + from gooddata_api_client.model.dashboard_compound_range_condition_range import DashboardCompoundRangeConditionRange + from gooddata_api_client.model.publisher_document_comparison_condition import PublisherDocumentComparisonCondition + from gooddata_api_client.model.publisher_document_range_condition import PublisherDocumentRangeCondition + globals()['DashboardCompoundComparisonConditionComparison'] = DashboardCompoundComparisonConditionComparison + globals()['DashboardCompoundRangeConditionRange'] = DashboardCompoundRangeConditionRange + globals()['PublisherDocumentComparisonCondition'] = PublisherDocumentComparisonCondition + globals()['PublisherDocumentRangeCondition'] = PublisherDocumentRangeCondition + + +class PublisherDocumentMeasureValueCondition(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': (DashboardCompoundComparisonConditionComparison,), # noqa: E501 + 'range': (DashboardCompoundRangeConditionRange,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'comparison': 'comparison', # noqa: E501 + 'range': 'range', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueCondition - 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 (DashboardCompoundComparisonConditionComparison): [optional] # noqa: E501 + range (DashboardCompoundRangeConditionRange): [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 + """PublisherDocumentMeasureValueCondition - 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 (DashboardCompoundComparisonConditionComparison): [optional] # noqa: E501 + range (DashboardCompoundRangeConditionRange): [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': [ + PublisherDocumentComparisonCondition, + PublisherDocumentRangeCondition, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter.py new file mode 100644 index 000000000..906f92d16 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_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.publisher_document_measure_value_filter_dashboard_measure_value_filter import PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter + globals()['PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter'] = PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter + + +class PublisherDocumentMeasureValueFilter(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 { + 'dashboard_measure_value_filter': (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'dashboard_measure_value_filter': 'dashboardMeasureValueFilter', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, dashboard_measure_value_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilter - a model defined in OpenAPI + + Args: + dashboard_measure_value_filter (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter): + + 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.dashboard_measure_value_filter = dashboard_measure_value_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, dashboard_measure_value_filter, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilter - a model defined in OpenAPI + + Args: + dashboard_measure_value_filter (PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter): + + 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.dashboard_measure_value_filter = dashboard_measure_value_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/publisher_document_measure_value_filter_dashboard_measure_value_filter.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter_dashboard_measure_value_filter.py new file mode 100644 index 000000000..2aeb094ad --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter_dashboard_measure_value_filter.py @@ -0,0 +1,301 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_measure_value_condition import PublisherDocumentMeasureValueCondition + from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentMeasureValueCondition'] = PublisherDocumentMeasureValueCondition + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter(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 = { + ('local_identifier',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'local_identifier': (str,), # noqa: E501 + 'measure': (PublisherDocumentObjRef,), # noqa: E501 + 'conditions': ([PublisherDocumentMeasureValueCondition],), # noqa: E501 + 'dimensionality': ([PublisherDocumentObjRef],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'local_identifier': 'localIdentifier', # noqa: E501 + 'measure': 'measure', # noqa: E501 + 'conditions': 'conditions', # noqa: E501 + 'dimensionality': 'dimensionality', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, local_identifier, measure, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter - a model defined in OpenAPI + + Args: + local_identifier (str): + measure (PublisherDocumentObjRef): + + 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,) + conditions ([PublisherDocumentMeasureValueCondition]): OR-ed conditions; none means all values.. [optional] # noqa: E501 + dimensionality ([PublisherDocumentObjRef]): [optional] # noqa: E501 + 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.local_identifier = local_identifier + self.measure = measure + 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, local_identifier, measure, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter - a model defined in OpenAPI + + Args: + local_identifier (str): + measure (PublisherDocumentObjRef): + + 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,) + conditions ([PublisherDocumentMeasureValueCondition]): OR-ed conditions; none means all values.. [optional] # noqa: E501 + dimensionality ([PublisherDocumentObjRef]): [optional] # noqa: E501 + 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.local_identifier = local_identifier + self.measure = measure + 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/publisher_document_measure_value_filter_reference.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter_reference.py new file mode 100644 index 000000000..37f576b1f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_measure_value_filter_reference.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.publisher_document_obj_ref import PublisherDocumentObjRef + globals()['PublisherDocumentObjRef'] = PublisherDocumentObjRef + + +class PublisherDocumentMeasureValueFilterReference(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',): { + 'MEASUREVALUEFILTERREFERENCE': "measureValueFilterReference", + }, + } + + 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 { + 'measure': (PublisherDocumentObjRef,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'measure': 'measure', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, measure, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilterReference - a model defined in OpenAPI + + Args: + measure (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "measureValueFilterReference", must be one of ["measureValueFilterReference", ] # 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', "measureValueFilterReference") + _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.measure = measure + 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, measure, *args, **kwargs): # noqa: E501 + """PublisherDocumentMeasureValueFilterReference - a model defined in OpenAPI + + Args: + measure (PublisherDocumentObjRef): + + Keyword Args: + type (str): defaults to "measureValueFilterReference", must be one of ["measureValueFilterReference", ] # 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', "measureValueFilterReference") + _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.measure = measure + 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/publisher_document_obj_ref.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_obj_ref.py new file mode 100644 index 000000000..08627710a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_obj_ref.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class PublisherDocumentObjRef(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 { + 'identifier': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'identifier': 'identifier', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, identifier, type, *args, **kwargs): # noqa: E501 + """PublisherDocumentObjRef - a model defined in OpenAPI + + Args: + identifier (str): + type (str): sdk-model object type, such as `displayForm`, `dataSet` or `measure`. + + 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.identifier = identifier + 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, identifier, type, *args, **kwargs): # noqa: E501 + """PublisherDocumentObjRef - a model defined in OpenAPI + + Args: + identifier (str): + type (str): sdk-model object type, such as `displayForm`, `dataSet` or `measure`. + + 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.identifier = identifier + 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/publisher_document_page.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_page.py new file mode 100644 index 000000000..e867d7a17 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_page.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 + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode + from gooddata_api_client.model.publisher_document_page_style import PublisherDocumentPageStyle + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentLayoutNode'] = PublisherDocumentLayoutNode + globals()['PublisherDocumentPageStyle'] = PublisherDocumentPageStyle + + +class PublisherDocumentPage(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 = { + ('kind',): { + 'COVER': "cover", + 'SECTION': "section", + 'CONTENT': "content", + }, + ('page_size',): { + 'WIDESCREEN': "widescreen", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # 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 { + 'layout': (PublisherDocumentLayoutNode,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'notes': (str,), # noqa: E501 + 'page_size': (str,), # noqa: E501 + 'style': (PublisherDocumentPageStyle,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'layout': 'layout', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'id': 'id', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'page_size': 'pageSize', # noqa: E501 + 'style': 'style', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, layout, *args, **kwargs): # noqa: E501 + """PublisherDocumentPage - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + id (str): Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [optional] # noqa: E501 + visible (bool): `false` keeps the page out of the viewer, exports and page numbering. Default `true`.. [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.layout = layout + 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, layout, *args, **kwargs): # noqa: E501 + """PublisherDocumentPage - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + id (str): Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [optional] # noqa: E501 + visible (bool): `false` keeps the page out of the viewer, exports and page numbering. Default `true`.. [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.layout = layout + 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/publisher_document_page_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_page_style.py new file mode 100644 index 000000000..f0e2e5a24 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_page_style.py @@ -0,0 +1,468 @@ +""" + 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.publisher_document_area_style_gap import PublisherDocumentAreaStyleGap + from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding + globals()['PublisherDocumentAreaStyleGap'] = PublisherDocumentAreaStyleGap + globals()['PublisherDocumentContainerStylePadding'] = PublisherDocumentContainerStylePadding + + +class PublisherDocumentPageStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + ('font_style',): { + 'NORMAL': "normal", + 'ITALIC': "italic", + }, + ('horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + 'JUSTIFY': "justify", + }, + ('text_overflow',): { + 'SHRINK': "shrink", + 'CLIP': "clip", + 'ELLIPSIS': "ellipsis", + }, + ('text_style',): { + 'TITLE': "title", + 'H1': "h1", + 'H2': "h2", + 'H3': "h3", + 'H4': "h4", + 'H5': "h5", + 'H6': "h6", + 'LARGETEXT': "largeText", + 'NORMALTEXT': "normalText", + 'SMALLTEXT': "smallText", + }, + ('text_transform',): { + 'NONE': "none", + 'UPPERCASE': "uppercase", + 'LOWERCASE': "lowercase", + 'CAPITALIZE': "capitalize", + }, + ('vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('font_weight',): { + 'inclusive_maximum': 1000, + 'inclusive_minimum': 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 = 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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'font_size': (float,), # noqa: E501 + 'font_style': (str,), # noqa: E501 + 'font_weight': (float,), # noqa: E501 + 'gap': (PublisherDocumentAreaStyleGap,), # noqa: E501 + 'horizontal_align': (str,), # noqa: E501 + 'letter_spacing': (float,), # noqa: E501 + 'line_height': (float,), # noqa: E501 + 'padding': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_bottom': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_left': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_right': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_top': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'text_color': (str,), # noqa: E501 + 'text_overflow': (str,), # noqa: E501 + 'text_style': (str,), # noqa: E501 + 'text_transform': (str,), # noqa: E501 + 'vertical_align': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'font_size': 'fontSize', # noqa: E501 + 'font_style': 'fontStyle', # noqa: E501 + 'font_weight': 'fontWeight', # noqa: E501 + 'gap': 'gap', # noqa: E501 + 'horizontal_align': 'horizontalAlign', # noqa: E501 + 'letter_spacing': 'letterSpacing', # noqa: E501 + 'line_height': 'lineHeight', # noqa: E501 + 'padding': 'padding', # noqa: E501 + 'padding_bottom': 'paddingBottom', # noqa: E501 + 'padding_left': 'paddingLeft', # noqa: E501 + 'padding_right': 'paddingRight', # noqa: E501 + 'padding_top': 'paddingTop', # noqa: E501 + 'text_color': 'textColor', # noqa: E501 + 'text_overflow': 'textOverflow', # noqa: E501 + 'text_style': 'textStyle', # noqa: E501 + 'text_transform': 'textTransform', # noqa: E501 + 'vertical_align': 'verticalAlign', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentPageStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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 + """PublisherDocumentPageStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + gap (PublisherDocumentAreaStyleGap): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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/publisher_document_page_template_content.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_page_template_content.py new file mode 100644 index 000000000..d8852010c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_page_template_content.py @@ -0,0 +1,308 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode + from gooddata_api_client.model.publisher_document_page_style import PublisherDocumentPageStyle + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentLayoutNode'] = PublisherDocumentLayoutNode + globals()['PublisherDocumentPageStyle'] = PublisherDocumentPageStyle + + +class PublisherDocumentPageTemplateContent(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 = { + ('kind',): { + 'COVER': "cover", + 'SECTION': "section", + 'CONTENT': "content", + }, + ('page_size',): { + 'WIDESCREEN': "widescreen", + }, + } + + 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 { + 'layout': (PublisherDocumentLayoutNode,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'notes': (str,), # noqa: E501 + 'page_size': (str,), # noqa: E501 + 'style': (PublisherDocumentPageStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'layout': 'layout', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'page_size': 'pageSize', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, layout, *args, **kwargs): # noqa: E501 + """PublisherDocumentPageTemplateContent - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [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.layout = layout + 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, layout, *args, **kwargs): # noqa: E501 + """PublisherDocumentPageTemplateContent - a model defined in OpenAPI + + Args: + layout (PublisherDocumentLayoutNode): + + 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,) + filters ([PublisherDocumentFilter]): Page filters; stored, not applied.. [optional] # noqa: E501 + kind (str): Editor hint.. [optional] # noqa: E501 + notes (str): Speaker notes in markdown, never drawn.. [optional] # noqa: E501 + page_size (str): [optional] if omitted the server will use the default value of "widescreen" # noqa: E501 + style (PublisherDocumentPageStyle): [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.layout = layout + 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/publisher_document_period.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_period.py new file mode 100644 index 000000000..aefafed84 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_period.py @@ -0,0 +1,361 @@ +""" + 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_publisher_document_period import AbsolutePublisherDocumentPeriod + from gooddata_api_client.model.relative_publisher_document_period import RelativePublisherDocumentPeriod + globals()['AbsolutePublisherDocumentPeriod'] = AbsolutePublisherDocumentPeriod + globals()['RelativePublisherDocumentPeriod'] = RelativePublisherDocumentPeriod + + +class PublisherDocumentPeriod(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',): { + 'RELATIVE': "relative", + }, + ('granularity',): { + 'SECOND': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + } + + 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 + '_from': (int,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + lazy_import() + val = { + 'AbsolutePublisherDocumentPeriod': AbsolutePublisherDocumentPeriod, + 'RelativePublisherDocumentPeriod': RelativePublisherDocumentPeriod, + 'absolute': AbsolutePublisherDocumentPeriod, + 'relative': RelativePublisherDocumentPeriod, + } + if not val: + return None + return {'type': val} + + attribute_map = { + 'type': 'type', # noqa: E501 + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): Type of the period.. defaults to "relative", must be one of ["relative", ] # 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,) + _from (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "relative") + _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 + """PublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): Type of the period.. defaults to "relative", must be one of ["relative", ] # 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,) + _from (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + """ + + type = kwargs.get('type', "relative") + _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': [ + AbsolutePublisherDocumentPeriod, + RelativePublisherDocumentPeriod, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/publisher_document_range_condition.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_range_condition.py new file mode 100644 index 000000000..602a9dfc4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_range_condition.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.dashboard_compound_range_condition_range import DashboardCompoundRangeConditionRange + globals()['DashboardCompoundRangeConditionRange'] = DashboardCompoundRangeConditionRange + + +class PublisherDocumentRangeCondition(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 { + 'range': (DashboardCompoundRangeConditionRange,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'range': 'range', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, range, *args, **kwargs): # noqa: E501 + """PublisherDocumentRangeCondition - a model defined in OpenAPI + + Args: + range (DashboardCompoundRangeConditionRange): + + 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.range = range + 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, range, *args, **kwargs): # noqa: E501 + """PublisherDocumentRangeCondition - a model defined in OpenAPI + + Args: + range (DashboardCompoundRangeConditionRange): + + 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.range = range + 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/publisher_document_row.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_row.py new file mode 100644 index 000000000..1e2f3e8fa --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_row.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.publisher_document_container_style import PublisherDocumentContainerStyle + from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode + globals()['PublisherDocumentContainerStyle'] = PublisherDocumentContainerStyle + globals()['PublisherDocumentLayoutNode'] = PublisherDocumentLayoutNode + + +class PublisherDocumentRow(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',): { + 'ROW': "row", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 { + 'children': ([PublisherDocumentLayoutNode],), # noqa: E501 + 'type': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentContainerStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'children': 'children', # noqa: E501 + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, children, *args, **kwargs): # noqa: E501 + """PublisherDocumentRow - a model defined in OpenAPI + + Args: + children ([PublisherDocumentLayoutNode]): Child nodes from left to right, in reading order; an empty list is a spacer. + + Keyword Args: + type (str): defaults to "row", must be one of ["row", ] # 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): [optional] # noqa: E501 + locked (bool): Locks the container in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): Share of the parent's main axis, greater than 0. Default 1.. [optional] # noqa: E501 + style (PublisherDocumentContainerStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "row") + _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.children = children + 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, children, *args, **kwargs): # noqa: E501 + """PublisherDocumentRow - a model defined in OpenAPI + + Args: + children ([PublisherDocumentLayoutNode]): Child nodes from left to right, in reading order; an empty list is a spacer. + + Keyword Args: + type (str): defaults to "row", must be one of ["row", ] # 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): [optional] # noqa: E501 + locked (bool): Locks the container in the document editor; never checked on write.. [optional] # noqa: E501 + proportion (float): Share of the parent's main axis, greater than 0. Default 1.. [optional] # noqa: E501 + style (PublisherDocumentContainerStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "row") + _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.children = children + 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/publisher_document_section.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_section.py new file mode 100644 index 000000000..e6347b511 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_section.py @@ -0,0 +1,293 @@ +""" + 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.publisher_document_page import PublisherDocumentPage + globals()['PublisherDocumentPage'] = PublisherDocumentPage + + +class PublisherDocumentSection(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,64}$', # 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 { + 'pages': ([PublisherDocumentPage],), # noqa: E501 + 'description': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'pages': 'pages', # noqa: E501 + 'description': 'description', # noqa: E501 + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, pages, *args, **kwargs): # noqa: E501 + """PublisherDocumentSection - a model defined in OpenAPI + + Args: + pages ([PublisherDocumentPage]): + + 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): [optional] # noqa: E501 + id (str): Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.. [optional] # noqa: E501 + 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.pages = pages + 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, pages, *args, **kwargs): # noqa: E501 + """PublisherDocumentSection - a model defined in OpenAPI + + Args: + pages ([PublisherDocumentPage]): + + 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): [optional] # noqa: E501 + id (str): Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.. [optional] # noqa: E501 + 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.pages = pages + 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/publisher_document_table_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_table_style.py new file mode 100644 index 000000000..df15d8091 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_table_style.py @@ -0,0 +1,306 @@ +""" + 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 PublisherDocumentTableStyle(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 = { + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('row_height',): { + 'inclusive_minimum': 0, + }, + } + + @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 { + 'font_size': (float,), # noqa: E501 + 'grid_color': (str,), # noqa: E501 + 'header_background_color': (str,), # noqa: E501 + 'header_label_color': (str,), # noqa: E501 + 'null_value_color': (str,), # noqa: E501 + 'row_height': (float,), # noqa: E501 + 'subtotal_background_color': (str,), # noqa: E501 + 'total_background_color': (str,), # noqa: E501 + 'total_value_color': (str,), # noqa: E501 + 'value_color': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'font_size': 'fontSize', # noqa: E501 + 'grid_color': 'gridColor', # noqa: E501 + 'header_background_color': 'headerBackgroundColor', # noqa: E501 + 'header_label_color': 'headerLabelColor', # noqa: E501 + 'null_value_color': 'nullValueColor', # noqa: E501 + 'row_height': 'rowHeight', # noqa: E501 + 'subtotal_background_color': 'subtotalBackgroundColor', # noqa: E501 + 'total_background_color': 'totalBackgroundColor', # noqa: E501 + 'total_value_color': 'totalValueColor', # noqa: E501 + 'value_color': 'valueColor', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTableStyle - 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,) + font_size (float): [optional] # noqa: E501 + grid_color (str): [optional] # noqa: E501 + header_background_color (str): [optional] # noqa: E501 + header_label_color (str): [optional] # noqa: E501 + null_value_color (str): [optional] # noqa: E501 + row_height (float): [optional] # noqa: E501 + subtotal_background_color (str): [optional] # noqa: E501 + total_background_color (str): [optional] # noqa: E501 + total_value_color (str): [optional] # noqa: E501 + value_color (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__,) + + 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 + """PublisherDocumentTableStyle - 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,) + font_size (float): [optional] # noqa: E501 + grid_color (str): [optional] # noqa: E501 + header_background_color (str): [optional] # noqa: E501 + header_label_color (str): [optional] # noqa: E501 + null_value_color (str): [optional] # noqa: E501 + row_height (float): [optional] # noqa: E501 + subtotal_background_color (str): [optional] # noqa: E501 + total_background_color (str): [optional] # noqa: E501 + total_value_color (str): [optional] # noqa: E501 + value_color (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__,) + + 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/publisher_document_takeaway_context.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_context.py new file mode 100644 index 000000000..b16df6495 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_context.py @@ -0,0 +1,276 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class PublisherDocumentTakeawayContext(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 { + 'filters': (bool,), # noqa: E501 + 'other_pages': (bool,), # noqa: E501 + 'page_title': (bool,), # noqa: E501 + 'widgets': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'filters': 'filters', # noqa: E501 + 'other_pages': 'otherPages', # noqa: E501 + 'page_title': 'pageTitle', # noqa: E501 + 'widgets': 'widgets', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTakeawayContext - 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,) + filters (bool): [optional] # noqa: E501 + other_pages (bool): [optional] # noqa: E501 + page_title (bool): [optional] # noqa: E501 + widgets ([str]): Widget ids on the same page.. [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 + """PublisherDocumentTakeawayContext - 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,) + filters (bool): [optional] # noqa: E501 + other_pages (bool): [optional] # noqa: E501 + page_title (bool): [optional] # noqa: E501 + widgets ([str]): Widget ids on the same page.. [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/publisher_document_takeaway_defaults.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_defaults.py new file mode 100644 index 000000000..ca548de6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_defaults.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.publisher_document_takeaway_generation import PublisherDocumentTakeawayGeneration + globals()['PublisherDocumentTakeawayGeneration'] = PublisherDocumentTakeawayGeneration + + +class PublisherDocumentTakeawayDefaults(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 { + 'generation': (PublisherDocumentTakeawayGeneration,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'generation': 'generation', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTakeawayDefaults - 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,) + generation (PublisherDocumentTakeawayGeneration): [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 + """PublisherDocumentTakeawayDefaults - 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,) + generation (PublisherDocumentTakeawayGeneration): [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/publisher_document_takeaway_generation.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_generation.py new file mode 100644 index 000000000..a6d7c289f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_generation.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 + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_takeaway_context import PublisherDocumentTakeawayContext + globals()['PublisherDocumentTakeawayContext'] = PublisherDocumentTakeawayContext + + +class PublisherDocumentTakeawayGeneration(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 { + 'context': (PublisherDocumentTakeawayContext,), # noqa: E501 + 'instructions': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'context': 'context', # noqa: E501 + 'instructions': 'instructions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTakeawayGeneration - 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,) + context (PublisherDocumentTakeawayContext): [optional] # noqa: E501 + instructions (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__,) + + 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 + """PublisherDocumentTakeawayGeneration - 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,) + context (PublisherDocumentTakeawayContext): [optional] # noqa: E501 + instructions (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__,) + + 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/publisher_document_takeaway_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_widget.py new file mode 100644 index 000000000..71df3bd54 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_takeaway_widget.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.publisher_document_takeaway_generation import PublisherDocumentTakeawayGeneration + from gooddata_api_client.model.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + from gooddata_api_client.model.publisher_document_widget_title import PublisherDocumentWidgetTitle + globals()['PublisherDocumentTakeawayGeneration'] = PublisherDocumentTakeawayGeneration + globals()['PublisherDocumentTextWidgetStyle'] = PublisherDocumentTextWidgetStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentWidgetTitle'] = PublisherDocumentWidgetTitle + + +class PublisherDocumentTakeawayWidget(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',): { + 'TAKEAWAY': "takeaway", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'generation': (PublisherDocumentTakeawayGeneration,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'markdown': (str,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentTextWidgetStyle,), # noqa: E501 + 'title': (PublisherDocumentWidgetTitle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'generation': 'generation', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'markdown': 'markdown', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentTakeawayWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "takeaway", must be one of ["takeaway", ] # 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,) + generation (PublisherDocumentTakeawayGeneration): [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): The generated text.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "takeaway") + _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 + """PublisherDocumentTakeawayWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "takeaway", must be one of ["takeaway", ] # 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,) + generation (PublisherDocumentTakeawayGeneration): [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): The generated text.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "takeaway") + _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/publisher_document_text_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_style.py new file mode 100644 index 000000000..33e8eb1db --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_style.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 + + + +class PublisherDocumentTextStyle(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 = { + ('font_style',): { + 'NORMAL': "normal", + 'ITALIC': "italic", + }, + ('horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + 'JUSTIFY': "justify", + }, + ('text_overflow',): { + 'SHRINK': "shrink", + 'CLIP': "clip", + 'ELLIPSIS': "ellipsis", + }, + ('text_style',): { + 'TITLE': "title", + 'H1': "h1", + 'H2': "h2", + 'H3': "h3", + 'H4': "h4", + 'H5': "h5", + 'H6': "h6", + 'LARGETEXT': "largeText", + 'NORMALTEXT': "normalText", + 'SMALLTEXT': "smallText", + }, + ('text_transform',): { + 'NONE': "none", + 'UPPERCASE': "uppercase", + 'LOWERCASE': "lowercase", + 'CAPITALIZE': "capitalize", + }, + ('vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('font_weight',): { + 'inclusive_maximum': 1000, + 'inclusive_minimum': 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 + """ + 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 { + 'font_size': (float,), # noqa: E501 + 'font_style': (str,), # noqa: E501 + 'font_weight': (float,), # noqa: E501 + 'horizontal_align': (str,), # noqa: E501 + 'letter_spacing': (float,), # noqa: E501 + 'line_height': (float,), # noqa: E501 + 'text_color': (str,), # noqa: E501 + 'text_overflow': (str,), # noqa: E501 + 'text_style': (str,), # noqa: E501 + 'text_transform': (str,), # noqa: E501 + 'vertical_align': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'font_size': 'fontSize', # noqa: E501 + 'font_style': 'fontStyle', # noqa: E501 + 'font_weight': 'fontWeight', # noqa: E501 + 'horizontal_align': 'horizontalAlign', # noqa: E501 + 'letter_spacing': 'letterSpacing', # noqa: E501 + 'line_height': 'lineHeight', # noqa: E501 + 'text_color': 'textColor', # noqa: E501 + 'text_overflow': 'textOverflow', # noqa: E501 + 'text_style': 'textStyle', # noqa: E501 + 'text_transform': 'textTransform', # noqa: E501 + 'vertical_align': 'verticalAlign', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTextStyle - 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,) + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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 + """PublisherDocumentTextStyle - 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,) + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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/publisher_document_text_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_widget.py new file mode 100644 index 000000000..d3aa4b1bd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_widget.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 + + +def lazy_import(): + from gooddata_api_client.model.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentTextWidgetStyle'] = PublisherDocumentTextWidgetStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + + +class PublisherDocumentTextWidget(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',): { + 'TEXT': "text", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'decorative': (bool,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'markdown': (str,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentTextWidgetStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'decorative': 'decorative', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'markdown': 'markdown', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentTextWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "text", must be one of ["text", ] # 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,) + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Full markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "text") + _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 + """PublisherDocumentTextWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "text", must be one of ["text", ] # 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,) + decorative (bool): Left out of the accessibility tree, PDF tags and the AI context.. [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Full markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "text") + _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/publisher_document_text_widget_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_widget_style.py new file mode 100644 index 000000000..ca68297ee --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_text_widget_style.py @@ -0,0 +1,632 @@ +""" + 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.publisher_document_container_style_border_bottom_left_radius import PublisherDocumentContainerStyleBorderBottomLeftRadius + from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding + globals()['PublisherDocumentContainerStyleBorderBottomLeftRadius'] = PublisherDocumentContainerStyleBorderBottomLeftRadius + globals()['PublisherDocumentContainerStylePadding'] = PublisherDocumentContainerStylePadding + + +class PublisherDocumentTextWidgetStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + ('border_bottom_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_left_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_right_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_top_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('font_style',): { + 'NORMAL': "normal", + 'ITALIC': "italic", + }, + ('horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + 'JUSTIFY': "justify", + }, + ('text_overflow',): { + 'SHRINK': "shrink", + 'CLIP': "clip", + 'ELLIPSIS': "ellipsis", + }, + ('text_style',): { + 'TITLE': "title", + 'H1': "h1", + 'H2': "h2", + 'H3': "h3", + 'H4': "h4", + 'H5': "h5", + 'H6': "h6", + 'LARGETEXT': "largeText", + 'NORMALTEXT': "normalText", + 'SMALLTEXT': "smallText", + }, + ('text_transform',): { + 'NONE': "none", + 'UPPERCASE': "uppercase", + 'LOWERCASE': "lowercase", + 'CAPITALIZE': "capitalize", + }, + ('vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('border_bottom_width',): { + 'inclusive_minimum': 0, + }, + ('border_left_width',): { + 'inclusive_minimum': 0, + }, + ('border_right_width',): { + 'inclusive_minimum': 0, + }, + ('border_top_width',): { + 'inclusive_minimum': 0, + }, + ('border_width',): { + 'inclusive_minimum': 0, + }, + ('font_size',): { + 'inclusive_minimum': 0, + }, + ('font_weight',): { + 'inclusive_maximum': 1000, + 'inclusive_minimum': 1, + }, + ('opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('shadow_blur',): { + 'inclusive_minimum': 0, + }, + ('shadow_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + } + + @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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'border_bottom_color': (str,), # noqa: E501 + 'border_bottom_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_style': (str,), # noqa: E501 + 'border_bottom_width': (float,), # noqa: E501 + 'border_color': (str,), # noqa: E501 + 'border_left_color': (str,), # noqa: E501 + 'border_left_style': (str,), # noqa: E501 + 'border_left_width': (float,), # noqa: E501 + 'border_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_right_color': (str,), # noqa: E501 + 'border_right_style': (str,), # noqa: E501 + 'border_right_width': (float,), # noqa: E501 + 'border_style': (str,), # noqa: E501 + 'border_top_color': (str,), # noqa: E501 + 'border_top_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_style': (str,), # noqa: E501 + 'border_top_width': (float,), # noqa: E501 + 'border_width': (float,), # noqa: E501 + 'font_size': (float,), # noqa: E501 + 'font_style': (str,), # noqa: E501 + 'font_weight': (float,), # noqa: E501 + 'horizontal_align': (str,), # noqa: E501 + 'letter_spacing': (float,), # noqa: E501 + 'line_height': (float,), # noqa: E501 + 'opacity': (float,), # noqa: E501 + 'padding': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_bottom': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_left': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_right': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_top': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'shadow': (str,), # noqa: E501 + 'shadow_blur': (float,), # noqa: E501 + 'shadow_color': (str,), # noqa: E501 + 'shadow_opacity': (float,), # noqa: E501 + 'shadow_spread': (float,), # noqa: E501 + 'shadow_x': (float,), # noqa: E501 + 'shadow_y': (float,), # noqa: E501 + 'text_color': (str,), # noqa: E501 + 'text_overflow': (str,), # noqa: E501 + 'text_style': (str,), # noqa: E501 + 'text_transform': (str,), # noqa: E501 + 'vertical_align': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'border_bottom_color': 'borderBottomColor', # noqa: E501 + 'border_bottom_left_radius': 'borderBottomLeftRadius', # noqa: E501 + 'border_bottom_right_radius': 'borderBottomRightRadius', # noqa: E501 + 'border_bottom_style': 'borderBottomStyle', # noqa: E501 + 'border_bottom_width': 'borderBottomWidth', # noqa: E501 + 'border_color': 'borderColor', # noqa: E501 + 'border_left_color': 'borderLeftColor', # noqa: E501 + 'border_left_style': 'borderLeftStyle', # noqa: E501 + 'border_left_width': 'borderLeftWidth', # noqa: E501 + 'border_radius': 'borderRadius', # noqa: E501 + 'border_right_color': 'borderRightColor', # noqa: E501 + 'border_right_style': 'borderRightStyle', # noqa: E501 + 'border_right_width': 'borderRightWidth', # noqa: E501 + 'border_style': 'borderStyle', # noqa: E501 + 'border_top_color': 'borderTopColor', # noqa: E501 + 'border_top_left_radius': 'borderTopLeftRadius', # noqa: E501 + 'border_top_right_radius': 'borderTopRightRadius', # noqa: E501 + 'border_top_style': 'borderTopStyle', # noqa: E501 + 'border_top_width': 'borderTopWidth', # noqa: E501 + 'border_width': 'borderWidth', # noqa: E501 + 'font_size': 'fontSize', # noqa: E501 + 'font_style': 'fontStyle', # noqa: E501 + 'font_weight': 'fontWeight', # noqa: E501 + 'horizontal_align': 'horizontalAlign', # noqa: E501 + 'letter_spacing': 'letterSpacing', # noqa: E501 + 'line_height': 'lineHeight', # noqa: E501 + 'opacity': 'opacity', # noqa: E501 + 'padding': 'padding', # noqa: E501 + 'padding_bottom': 'paddingBottom', # noqa: E501 + 'padding_left': 'paddingLeft', # noqa: E501 + 'padding_right': 'paddingRight', # noqa: E501 + 'padding_top': 'paddingTop', # noqa: E501 + 'shadow': 'shadow', # noqa: E501 + 'shadow_blur': 'shadowBlur', # noqa: E501 + 'shadow_color': 'shadowColor', # noqa: E501 + 'shadow_opacity': 'shadowOpacity', # noqa: E501 + 'shadow_spread': 'shadowSpread', # noqa: E501 + 'shadow_x': 'shadowX', # noqa: E501 + 'shadow_y': 'shadowY', # noqa: E501 + 'text_color': 'textColor', # noqa: E501 + 'text_overflow': 'textOverflow', # noqa: E501 + 'text_style': 'textStyle', # noqa: E501 + 'text_transform': 'textTransform', # noqa: E501 + 'vertical_align': 'verticalAlign', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentTextWidgetStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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 + """PublisherDocumentTextWidgetStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + font_size (float): [optional] # noqa: E501 + font_style (str): [optional] # noqa: E501 + font_weight (float): [optional] # noqa: E501 + horizontal_align (str): [optional] # noqa: E501 + letter_spacing (float): [optional] # noqa: E501 + line_height (float): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + text_color (str): [optional] # noqa: E501 + text_overflow (str): [optional] # noqa: E501 + text_style (str): [optional] # noqa: E501 + text_transform (str): [optional] # noqa: E501 + vertical_align (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__,) + + 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/publisher_document_title_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_title_widget.py new file mode 100644 index 000000000..670e27c07 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_title_widget.py @@ -0,0 +1,317 @@ +""" + 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.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentTextWidgetStyle'] = PublisherDocumentTextWidgetStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + + +class PublisherDocumentTitleWidget(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',): { + 'TITLE': "title", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'locked': (bool,), # noqa: E501 + 'markdown': (str,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentTextWidgetStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'markdown': 'markdown', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentTitleWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "title", must be one of ["title", ] # 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,) + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Inline markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "title") + _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 + """PublisherDocumentTitleWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "title", must be one of ["title", ] # 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,) + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + markdown (str): Inline markdown.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentTextWidgetStyle): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "title") + _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/publisher_document_visibility.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_visibility.py new file mode 100644 index 000000000..cd448f144 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_visibility.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 PublisherDocumentVisibility(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 { + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisibility - 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,) + visible (bool): [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 + """PublisherDocumentVisibility - 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,) + visible (bool): [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/publisher_document_visualization_display.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_display.py new file mode 100644 index 000000000..d04d245fb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_display.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.publisher_document_auto_visibility import PublisherDocumentAutoVisibility + from gooddata_api_client.model.publisher_document_axis_display import PublisherDocumentAxisDisplay + from gooddata_api_client.model.publisher_document_legend_display import PublisherDocumentLegendDisplay + from gooddata_api_client.model.publisher_document_visibility import PublisherDocumentVisibility + globals()['PublisherDocumentAutoVisibility'] = PublisherDocumentAutoVisibility + globals()['PublisherDocumentAxisDisplay'] = PublisherDocumentAxisDisplay + globals()['PublisherDocumentLegendDisplay'] = PublisherDocumentLegendDisplay + globals()['PublisherDocumentVisibility'] = PublisherDocumentVisibility + + +class PublisherDocumentVisualizationDisplay(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_labels': (PublisherDocumentAutoVisibility,), # noqa: E501 + 'data_points': (PublisherDocumentAutoVisibility,), # noqa: E501 + 'gridlines': (PublisherDocumentVisibility,), # noqa: E501 + 'legend': (PublisherDocumentLegendDisplay,), # noqa: E501 + 'secondary_y_axis': (PublisherDocumentAxisDisplay,), # noqa: E501 + 'x_axis': (PublisherDocumentAxisDisplay,), # noqa: E501 + 'y_axis': (PublisherDocumentAxisDisplay,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'data_labels': 'dataLabels', # noqa: E501 + 'data_points': 'dataPoints', # noqa: E501 + 'gridlines': 'gridlines', # noqa: E501 + 'legend': 'legend', # noqa: E501 + 'secondary_y_axis': 'secondaryYAxis', # noqa: E501 + 'x_axis': 'xAxis', # noqa: E501 + 'y_axis': 'yAxis', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisualizationDisplay - 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_labels (PublisherDocumentAutoVisibility): [optional] # noqa: E501 + data_points (PublisherDocumentAutoVisibility): [optional] # noqa: E501 + gridlines (PublisherDocumentVisibility): [optional] # noqa: E501 + legend (PublisherDocumentLegendDisplay): [optional] # noqa: E501 + secondary_y_axis (PublisherDocumentAxisDisplay): [optional] # noqa: E501 + x_axis (PublisherDocumentAxisDisplay): [optional] # noqa: E501 + y_axis (PublisherDocumentAxisDisplay): [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 + """PublisherDocumentVisualizationDisplay - 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_labels (PublisherDocumentAutoVisibility): [optional] # noqa: E501 + data_points (PublisherDocumentAutoVisibility): [optional] # noqa: E501 + gridlines (PublisherDocumentVisibility): [optional] # noqa: E501 + legend (PublisherDocumentLegendDisplay): [optional] # noqa: E501 + secondary_y_axis (PublisherDocumentAxisDisplay): [optional] # noqa: E501 + x_axis (PublisherDocumentAxisDisplay): [optional] # noqa: E501 + y_axis (PublisherDocumentAxisDisplay): [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/publisher_document_visualization_ref.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_ref.py new file mode 100644 index 000000000..131c2f9fe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_ref.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 PublisherDocumentVisualizationRef(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',): { + 'INSIGHT': "insight", + }, + } + + 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 { + 'identifier': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'identifier': 'identifier', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisualizationRef - a model defined in OpenAPI + + Args: + identifier (str): + + Keyword Args: + 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. + 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', "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', ()) + _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.identifier = identifier + 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, identifier, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisualizationRef - a model defined in OpenAPI + + Args: + identifier (str): + + Keyword Args: + 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. + 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', "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', ()) + _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.identifier = identifier + 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/publisher_document_visualization_style.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_style.py new file mode 100644 index 000000000..a30a06f72 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_style.py @@ -0,0 +1,561 @@ +""" + 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.publisher_document_chart_style import PublisherDocumentChartStyle + from gooddata_api_client.model.publisher_document_container_style_border_bottom_left_radius import PublisherDocumentContainerStyleBorderBottomLeftRadius + from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding + from gooddata_api_client.model.publisher_document_headline_style import PublisherDocumentHeadlineStyle + from gooddata_api_client.model.publisher_document_table_style import PublisherDocumentTableStyle + globals()['PublisherDocumentChartStyle'] = PublisherDocumentChartStyle + globals()['PublisherDocumentContainerStyleBorderBottomLeftRadius'] = PublisherDocumentContainerStyleBorderBottomLeftRadius + globals()['PublisherDocumentContainerStylePadding'] = PublisherDocumentContainerStylePadding + globals()['PublisherDocumentHeadlineStyle'] = PublisherDocumentHeadlineStyle + globals()['PublisherDocumentTableStyle'] = PublisherDocumentTableStyle + + +class PublisherDocumentVisualizationStyle(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 = { + ('background_fit',): { + 'COVER': "cover", + 'CONTAIN': "contain", + 'FILL': "fill", + 'TILE': "tile", + }, + ('background_horizontal_align',): { + 'LEFT': "left", + 'CENTER': "center", + 'RIGHT': "right", + }, + ('background_vertical_align',): { + 'TOP': "top", + 'CENTER': "center", + 'BOTTOM': "bottom", + }, + ('border_bottom_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_left_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_right_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + ('border_top_style',): { + 'SOLID': "solid", + 'DASHED': "dashed", + 'DOTTED': "dotted", + 'NONE': "none", + }, + } + + validations = { + ('background_image_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('background_offset',): { + 'inclusive_minimum': 0, + }, + ('background_offset_bottom',): { + 'inclusive_minimum': 0, + }, + ('background_offset_left',): { + 'inclusive_minimum': 0, + }, + ('background_offset_right',): { + 'inclusive_minimum': 0, + }, + ('background_offset_top',): { + 'inclusive_minimum': 0, + }, + ('background_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('border_bottom_width',): { + 'inclusive_minimum': 0, + }, + ('border_left_width',): { + 'inclusive_minimum': 0, + }, + ('border_right_width',): { + 'inclusive_minimum': 0, + }, + ('border_top_width',): { + 'inclusive_minimum': 0, + }, + ('border_width',): { + 'inclusive_minimum': 0, + }, + ('opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + ('shadow_blur',): { + 'inclusive_minimum': 0, + }, + ('shadow_opacity',): { + 'inclusive_maximum': 1, + 'inclusive_minimum': 0, + }, + } + + @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 { + 'background_color': (str,), # noqa: E501 + 'background_fit': (str,), # noqa: E501 + 'background_horizontal_align': (str,), # noqa: E501 + 'background_image': (str,), # noqa: E501 + 'background_image_opacity': (float,), # noqa: E501 + 'background_offset': (float,), # noqa: E501 + 'background_offset_bottom': (float,), # noqa: E501 + 'background_offset_left': (float,), # noqa: E501 + 'background_offset_right': (float,), # noqa: E501 + 'background_offset_top': (float,), # noqa: E501 + 'background_opacity': (float,), # noqa: E501 + 'background_vertical_align': (str,), # noqa: E501 + 'border_bottom_color': (str,), # noqa: E501 + 'border_bottom_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_bottom_style': (str,), # noqa: E501 + 'border_bottom_width': (float,), # noqa: E501 + 'border_color': (str,), # noqa: E501 + 'border_left_color': (str,), # noqa: E501 + 'border_left_style': (str,), # noqa: E501 + 'border_left_width': (float,), # noqa: E501 + 'border_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_right_color': (str,), # noqa: E501 + 'border_right_style': (str,), # noqa: E501 + 'border_right_width': (float,), # noqa: E501 + 'border_style': (str,), # noqa: E501 + 'border_top_color': (str,), # noqa: E501 + 'border_top_left_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_right_radius': (PublisherDocumentContainerStyleBorderBottomLeftRadius,), # noqa: E501 + 'border_top_style': (str,), # noqa: E501 + 'border_top_width': (float,), # noqa: E501 + 'border_width': (float,), # noqa: E501 + 'chart': (PublisherDocumentChartStyle,), # noqa: E501 + 'headline': (PublisherDocumentHeadlineStyle,), # noqa: E501 + 'opacity': (float,), # noqa: E501 + 'padding': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_bottom': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_left': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_right': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'padding_top': (PublisherDocumentContainerStylePadding,), # noqa: E501 + 'shadow': (str,), # noqa: E501 + 'shadow_blur': (float,), # noqa: E501 + 'shadow_color': (str,), # noqa: E501 + 'shadow_opacity': (float,), # noqa: E501 + 'shadow_spread': (float,), # noqa: E501 + 'shadow_x': (float,), # noqa: E501 + 'shadow_y': (float,), # noqa: E501 + 'table': (PublisherDocumentTableStyle,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'background_color': 'backgroundColor', # noqa: E501 + 'background_fit': 'backgroundFit', # noqa: E501 + 'background_horizontal_align': 'backgroundHorizontalAlign', # noqa: E501 + 'background_image': 'backgroundImage', # noqa: E501 + 'background_image_opacity': 'backgroundImageOpacity', # noqa: E501 + 'background_offset': 'backgroundOffset', # noqa: E501 + 'background_offset_bottom': 'backgroundOffsetBottom', # noqa: E501 + 'background_offset_left': 'backgroundOffsetLeft', # noqa: E501 + 'background_offset_right': 'backgroundOffsetRight', # noqa: E501 + 'background_offset_top': 'backgroundOffsetTop', # noqa: E501 + 'background_opacity': 'backgroundOpacity', # noqa: E501 + 'background_vertical_align': 'backgroundVerticalAlign', # noqa: E501 + 'border_bottom_color': 'borderBottomColor', # noqa: E501 + 'border_bottom_left_radius': 'borderBottomLeftRadius', # noqa: E501 + 'border_bottom_right_radius': 'borderBottomRightRadius', # noqa: E501 + 'border_bottom_style': 'borderBottomStyle', # noqa: E501 + 'border_bottom_width': 'borderBottomWidth', # noqa: E501 + 'border_color': 'borderColor', # noqa: E501 + 'border_left_color': 'borderLeftColor', # noqa: E501 + 'border_left_style': 'borderLeftStyle', # noqa: E501 + 'border_left_width': 'borderLeftWidth', # noqa: E501 + 'border_radius': 'borderRadius', # noqa: E501 + 'border_right_color': 'borderRightColor', # noqa: E501 + 'border_right_style': 'borderRightStyle', # noqa: E501 + 'border_right_width': 'borderRightWidth', # noqa: E501 + 'border_style': 'borderStyle', # noqa: E501 + 'border_top_color': 'borderTopColor', # noqa: E501 + 'border_top_left_radius': 'borderTopLeftRadius', # noqa: E501 + 'border_top_right_radius': 'borderTopRightRadius', # noqa: E501 + 'border_top_style': 'borderTopStyle', # noqa: E501 + 'border_top_width': 'borderTopWidth', # noqa: E501 + 'border_width': 'borderWidth', # noqa: E501 + 'chart': 'chart', # noqa: E501 + 'headline': 'headline', # noqa: E501 + 'opacity': 'opacity', # noqa: E501 + 'padding': 'padding', # noqa: E501 + 'padding_bottom': 'paddingBottom', # noqa: E501 + 'padding_left': 'paddingLeft', # noqa: E501 + 'padding_right': 'paddingRight', # noqa: E501 + 'padding_top': 'paddingTop', # noqa: E501 + 'shadow': 'shadow', # noqa: E501 + 'shadow_blur': 'shadowBlur', # noqa: E501 + 'shadow_color': 'shadowColor', # noqa: E501 + 'shadow_opacity': 'shadowOpacity', # noqa: E501 + 'shadow_spread': 'shadowSpread', # noqa: E501 + 'shadow_x': 'shadowX', # noqa: E501 + 'shadow_y': 'shadowY', # noqa: E501 + 'table': 'table', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisualizationStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + chart (PublisherDocumentChartStyle): [optional] # noqa: E501 + headline (PublisherDocumentHeadlineStyle): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + table (PublisherDocumentTableStyle): [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 + """PublisherDocumentVisualizationStyle - 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,) + background_color (str): [optional] # noqa: E501 + background_fit (str): [optional] # noqa: E501 + background_horizontal_align (str): [optional] # noqa: E501 + background_image (str): [optional] # noqa: E501 + background_image_opacity (float): [optional] # noqa: E501 + background_offset (float): [optional] # noqa: E501 + background_offset_bottom (float): [optional] # noqa: E501 + background_offset_left (float): [optional] # noqa: E501 + background_offset_right (float): [optional] # noqa: E501 + background_offset_top (float): [optional] # noqa: E501 + background_opacity (float): [optional] # noqa: E501 + background_vertical_align (str): [optional] # noqa: E501 + border_bottom_color (str): [optional] # noqa: E501 + border_bottom_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_bottom_style (str): [optional] # noqa: E501 + border_bottom_width (float): [optional] # noqa: E501 + border_color (str): [optional] # noqa: E501 + border_left_color (str): [optional] # noqa: E501 + border_left_style (str): [optional] # noqa: E501 + border_left_width (float): [optional] # noqa: E501 + border_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_right_color (str): [optional] # noqa: E501 + border_right_style (str): [optional] # noqa: E501 + border_right_width (float): [optional] # noqa: E501 + border_style (str): [optional] # noqa: E501 + border_top_color (str): [optional] # noqa: E501 + border_top_left_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_right_radius (PublisherDocumentContainerStyleBorderBottomLeftRadius): [optional] # noqa: E501 + border_top_style (str): [optional] # noqa: E501 + border_top_width (float): [optional] # noqa: E501 + border_width (float): [optional] # noqa: E501 + chart (PublisherDocumentChartStyle): [optional] # noqa: E501 + headline (PublisherDocumentHeadlineStyle): [optional] # noqa: E501 + opacity (float): [optional] # noqa: E501 + padding (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_bottom (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_left (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_right (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + padding_top (PublisherDocumentContainerStylePadding): [optional] # noqa: E501 + shadow (str): [optional] # noqa: E501 + shadow_blur (float): [optional] # noqa: E501 + shadow_color (str): [optional] # noqa: E501 + shadow_opacity (float): [optional] # noqa: E501 + shadow_spread (float): [optional] # noqa: E501 + shadow_x (float): [optional] # noqa: E501 + shadow_y (float): [optional] # noqa: E501 + table (PublisherDocumentTableStyle): [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/publisher_document_visualization_widget.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_widget.py new file mode 100644 index 000000000..edcdfa85c --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_visualization_widget.py @@ -0,0 +1,357 @@ +""" + 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.publisher_document_data_set_ref import PublisherDocumentDataSetRef + from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter + from gooddata_api_client.model.publisher_document_filter_reference import PublisherDocumentFilterReference + from gooddata_api_client.model.publisher_document_visualization_display import PublisherDocumentVisualizationDisplay + from gooddata_api_client.model.publisher_document_visualization_ref import PublisherDocumentVisualizationRef + from gooddata_api_client.model.publisher_document_visualization_style import PublisherDocumentVisualizationStyle + from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder + from gooddata_api_client.model.publisher_document_widget_title import PublisherDocumentWidgetTitle + globals()['PublisherDocumentDataSetRef'] = PublisherDocumentDataSetRef + globals()['PublisherDocumentFilter'] = PublisherDocumentFilter + globals()['PublisherDocumentFilterReference'] = PublisherDocumentFilterReference + globals()['PublisherDocumentVisualizationDisplay'] = PublisherDocumentVisualizationDisplay + globals()['PublisherDocumentVisualizationRef'] = PublisherDocumentVisualizationRef + globals()['PublisherDocumentVisualizationStyle'] = PublisherDocumentVisualizationStyle + globals()['PublisherDocumentWidgetPlaceholder'] = PublisherDocumentWidgetPlaceholder + globals()['PublisherDocumentWidgetTitle'] = PublisherDocumentWidgetTitle + + +class PublisherDocumentVisualizationWidget(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',): { + 'VISUALIZATION': "visualization", + }, + } + + validations = { + ('id',): { + 'regex': { + 'pattern': r'^[A-Za-z0-9_.-]{1,64}$', # noqa: E501 + }, + }, + ('proportion',): { + 'exclusive_minimum''inclusive_minimum': 0, + }, + } + + @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 + 'alt_text': (str,), # noqa: E501 + 'date_data_set': (PublisherDocumentDataSetRef,), # noqa: E501 + 'display': (PublisherDocumentVisualizationDisplay,), # noqa: E501 + 'filters': ([PublisherDocumentFilter],), # noqa: E501 + 'ignore_document_filters': ([PublisherDocumentFilterReference],), # noqa: E501 + 'ignore_document_period': (bool,), # noqa: E501 + 'locked': (bool,), # noqa: E501 + 'placeholder': (PublisherDocumentWidgetPlaceholder,), # noqa: E501 + 'proportion': (float,), # noqa: E501 + 'style': (PublisherDocumentVisualizationStyle,), # noqa: E501 + 'title': (PublisherDocumentWidgetTitle,), # noqa: E501 + 'visualization': (PublisherDocumentVisualizationRef,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'alt_text': 'altText', # noqa: E501 + 'date_data_set': 'dateDataSet', # noqa: E501 + 'display': 'display', # noqa: E501 + 'filters': 'filters', # noqa: E501 + 'ignore_document_filters': 'ignoreDocumentFilters', # noqa: E501 + 'ignore_document_period': 'ignoreDocumentPeriod', # noqa: E501 + 'locked': 'locked', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'proportion': 'proportion', # noqa: E501 + 'style': 'style', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visualization': 'visualization', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """PublisherDocumentVisualizationWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "visualization", must be one of ["visualization", ] # 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,) + alt_text (str): Defaults to the visualization's description.. [optional] # noqa: E501 + date_data_set (PublisherDocumentDataSetRef): [optional] # noqa: E501 + display (PublisherDocumentVisualizationDisplay): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Widget filters; stored, not applied.. [optional] # noqa: E501 + ignore_document_filters ([PublisherDocumentFilterReference]): Document filters this widget ignores.. [optional] # noqa: E501 + ignore_document_period (bool): [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentVisualizationStyle): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + visualization (PublisherDocumentVisualizationRef): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "visualization") + _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 + """PublisherDocumentVisualizationWidget - a model defined in OpenAPI + + Args: + id (str): Unique within the page. + + Keyword Args: + type (str): defaults to "visualization", must be one of ["visualization", ] # 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,) + alt_text (str): Defaults to the visualization's description.. [optional] # noqa: E501 + date_data_set (PublisherDocumentDataSetRef): [optional] # noqa: E501 + display (PublisherDocumentVisualizationDisplay): [optional] # noqa: E501 + filters ([PublisherDocumentFilter]): Widget filters; stored, not applied.. [optional] # noqa: E501 + ignore_document_filters ([PublisherDocumentFilterReference]): Document filters this widget ignores.. [optional] # noqa: E501 + ignore_document_period (bool): [optional] # noqa: E501 + locked (bool): Locks the widget in the document editor; never checked on write.. [optional] # noqa: E501 + placeholder (PublisherDocumentWidgetPlaceholder): [optional] # noqa: E501 + proportion (float): [optional] # noqa: E501 + style (PublisherDocumentVisualizationStyle): [optional] # noqa: E501 + title (PublisherDocumentWidgetTitle): [optional] # noqa: E501 + visualization (PublisherDocumentVisualizationRef): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "visualization") + _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/publisher_document_widget_placeholder.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_placeholder.py new file mode 100644 index 000000000..3b5da84b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_placeholder.py @@ -0,0 +1,268 @@ +""" + 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 PublisherDocumentWidgetPlaceholder(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 { + 'hint': (str,), # noqa: E501 + 'required': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'hint': 'hint', # noqa: E501 + 'required': 'required', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentWidgetPlaceholder - 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,) + hint (str): [optional] # noqa: E501 + required (bool): [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 + """PublisherDocumentWidgetPlaceholder - 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,) + hint (str): [optional] # noqa: E501 + required (bool): [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/publisher_document_widget_title.py b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py new file mode 100644 index 000000000..4ad069de6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/publisher_document_widget_title.py @@ -0,0 +1,278 @@ +""" + 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.publisher_document_text_style import PublisherDocumentTextStyle + globals()['PublisherDocumentTextStyle'] = PublisherDocumentTextStyle + + +class PublisherDocumentWidgetTitle(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 { + 'style': (PublisherDocumentTextStyle,), # noqa: E501 + 'text': (str,), # noqa: E501 + 'visible': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'style': 'style', # noqa: E501 + 'text': 'text', # noqa: E501 + 'visible': 'visible', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PublisherDocumentWidgetTitle - 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,) + style (PublisherDocumentTextStyle): [optional] # noqa: E501 + text (str): Overrides the default title; may contain text variables.. [optional] # noqa: E501 + visible (bool): Default `true`.. [optional] # noqa: E501 + """ + + _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 + """PublisherDocumentWidgetTitle - 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,) + style (PublisherDocumentTextStyle): [optional] # noqa: E501 + text (str): Overrides the default title; may contain text variables.. [optional] # noqa: E501 + visible (bool): Default `true`.. [optional] # noqa: E501 + """ + + _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/relative_publisher_document_period.py b/gooddata-api-client/gooddata_api_client/model/relative_publisher_document_period.py new file mode 100644 index 000000000..64ff1c186 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/relative_publisher_document_period.py @@ -0,0 +1,350 @@ +""" + 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.relative_publisher_document_period_all_of import RelativePublisherDocumentPeriodAllOf + globals()['RelativePublisherDocumentPeriodAllOf'] = RelativePublisherDocumentPeriodAllOf + + +class RelativePublisherDocumentPeriod(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',): { + 'RELATIVE': "relative", + }, + ('granularity',): { + 'SECOND': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + } + + 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 + '_from': (int,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RelativePublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "relative", must be one of ["relative", ] # noqa: E501 + _from (int): Start of the period, in units relative to the current one. + granularity (str): Date granularity of the period. + to (int): End of the period, in units relative to the current one. + _check_type (bool): 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', "relative") + _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 + """RelativePublisherDocumentPeriod - a model defined in OpenAPI + + Keyword Args: + type (str): defaults to "relative", must be one of ["relative", ] # noqa: E501 + _from (int): Start of the period, in units relative to the current one. + granularity (str): Date granularity of the period. + to (int): End of the period, in units relative to the current one. + _check_type (bool): 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', "relative") + _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': [ + RelativePublisherDocumentPeriodAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/relative_publisher_document_period_all_of.py b/gooddata-api-client/gooddata_api_client/model/relative_publisher_document_period_all_of.py new file mode 100644 index 000000000..c54a82f85 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/relative_publisher_document_period_all_of.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 + + + +class RelativePublisherDocumentPeriodAllOf(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': "GDC.time.second", + 'MINUTE': "GDC.time.minute", + 'HOUR': "GDC.time.hour", + 'DATE': "GDC.time.date", + 'WEEK_US': "GDC.time.week_us", + 'MONTH': "GDC.time.month", + 'FISCAL_MONTH': "GDC.time.fiscal_month", + 'QUARTER': "GDC.time.quarter", + 'FISCAL_QUARTER': "GDC.time.fiscal_quarter", + 'YEAR': "GDC.time.year", + 'FISCAL_YEAR': "GDC.time.fiscal_year", + }, + ('type',): { + 'RELATIVE': "relative", + }, + } + + 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 { + '_from': (int,), # noqa: E501 + 'granularity': (str,), # noqa: E501 + 'to': (int,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '_from': 'from', # noqa: E501 + 'granularity': 'granularity', # noqa: E501 + 'to': 'to', # noqa: E501 + '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 + """RelativePublisherDocumentPeriodAllOf - 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 (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + type (str): Type of the period.. [optional] if omitted the server will use the default value of "relative" # 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 + """RelativePublisherDocumentPeriodAllOf - 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 (int): Start of the period, in units relative to the current one.. [optional] # noqa: E501 + granularity (str): Date granularity of the period.. [optional] # noqa: E501 + to (int): End of the period, in units relative to the current one.. [optional] # noqa: E501 + type (str): Type of the period.. [optional] if omitted the server will use the default value of "relative" # 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/report_export_request.py b/gooddata-api-client/gooddata_api_client/model/report_export_request.py index 33edf7056..5d80a6be3 100644 --- a/gooddata-api-client/gooddata_api_client/model/report_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/report_export_request.py @@ -93,8 +93,9 @@ def openapi_types(): return { 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 - 'report_id': (str,), # noqa: E501 + 'document_id': (str,), # noqa: E501 'metadata': (JsonNode,), # noqa: E501 + 'report_id': (str,), # noqa: E501 'timezone_id': (str, none_type,), # noqa: E501 } @@ -106,8 +107,9 @@ def discriminator(): attribute_map = { 'file_name': 'fileName', # noqa: E501 'format': 'format', # noqa: E501 - 'report_id': 'reportId', # noqa: E501 + 'document_id': 'documentId', # noqa: E501 'metadata': 'metadata', # noqa: E501 + 'report_id': 'reportId', # noqa: E501 'timezone_id': 'timezoneId', # noqa: E501 } @@ -118,12 +120,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, file_name, report_id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, file_name, *args, **kwargs): # noqa: E501 """ReportExportRequest - a model defined in OpenAPI Args: file_name (str): File name to be used for retrieving the pdf document. - report_id (str): Report identifier Keyword Args: format (str): Requested resulting file type.. defaults to "PDF", must be one of ["PDF", ] # noqa: E501 @@ -157,7 +158,9 @@ def _from_openapi_data(cls, file_name, report_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,) + document_id (str): Document identifier; the export renders the Publisher document page.. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 + report_id (str): Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.. [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 """ @@ -193,7 +196,6 @@ def _from_openapi_data(cls, file_name, report_id, *args, **kwargs): # noqa: E50 self.file_name = file_name self.format = format - self.report_id = report_id for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -214,12 +216,11 @@ def _from_openapi_data(cls, file_name, report_id, *args, **kwargs): # noqa: E50 ]) @convert_js_args_to_python_args - def __init__(self, file_name, report_id, *args, **kwargs): # noqa: E501 + def __init__(self, file_name, *args, **kwargs): # noqa: E501 """ReportExportRequest - a model defined in OpenAPI Args: file_name (str): File name to be used for retrieving the pdf document. - report_id (str): Report identifier Keyword Args: format (str): Requested resulting file type.. defaults to "PDF", must be one of ["PDF", ] # noqa: E501 @@ -253,7 +254,9 @@ def __init__(self, file_name, report_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,) + document_id (str): Document identifier; the export renders the Publisher document page.. [optional] # noqa: E501 metadata (JsonNode): [optional] # noqa: E501 + report_id (str): Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.. [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 """ @@ -287,7 +290,6 @@ def __init__(self, file_name, report_id, *args, **kwargs): # noqa: E501 self.file_name = file_name self.format = format - self.report_id = report_id for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/test_definition_request.py b/gooddata-api-client/gooddata_api_client/model/test_definition_request.py index e2271ddd3..959e5bc83 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 @@ -84,7 +84,6 @@ class TestDefinitionRequest(ModelNormal): 'FLEXCONNECT': "FLEXCONNECT", 'STARROCKS': "STARROCKS", 'ATHENA': "ATHENA", - 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_localization_usage.py b/gooddata-api-client/gooddata_api_client/model/workspace_localization_usage.py new file mode 100644 index 000000000..d14980295 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/workspace_localization_usage.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.localization_resolved_values import LocalizationResolvedValues + from gooddata_api_client.model.localization_usage_value import LocalizationUsageValue + globals()['LocalizationResolvedValues'] = LocalizationResolvedValues + globals()['LocalizationUsageValue'] = LocalizationUsageValue + + +class WorkspaceLocalizationUsage(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 { + 'settings': (LocalizationResolvedValues,), # noqa: E501 + 'values': ([LocalizationUsageValue],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'settings': 'settings', # noqa: E501 + 'values': 'values', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, settings, values, *args, **kwargs): # noqa: E501 + """WorkspaceLocalizationUsage - a model defined in OpenAPI + + Args: + settings (LocalizationResolvedValues): + values ([LocalizationUsageValue]): + + 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.settings = settings + self.values = values + 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, settings, values, *args, **kwargs): # noqa: E501 + """WorkspaceLocalizationUsage - a model defined in OpenAPI + + Args: + settings (LocalizationResolvedValues): + values ([LocalizationUsageValue]): + + 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.settings = settings + self.values = values + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index a5118bc89..d346f8a26 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -14,6 +14,8 @@ 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.absolute_publisher_document_period import AbsolutePublisherDocumentPeriod +from gooddata_api_client.model.absolute_publisher_document_period_all_of import AbsolutePublisherDocumentPeriodAllOf from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation from gooddata_api_client.model.add_database_data_source_request import AddDatabaseDataSourceRequest @@ -58,6 +60,12 @@ from gooddata_api_client.model.analyze_csv_response import AnalyzeCsvResponse from gooddata_api_client.model.analyze_csv_response_column import AnalyzeCsvResponseColumn from gooddata_api_client.model.analyze_csv_response_config import AnalyzeCsvResponseConfig +from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest +from gooddata_api_client.model.analyze_sav_request_item import AnalyzeSavRequestItem +from gooddata_api_client.model.analyze_sav_request_item_config import AnalyzeSavRequestItemConfig +from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse +from gooddata_api_client.model.analyze_sav_response_column import AnalyzeSavResponseColumn +from gooddata_api_client.model.analyze_sav_response_value_label import AnalyzeSavResponseValueLabel from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest from gooddata_api_client.model.anomaly_detection import AnomalyDetection from gooddata_api_client.model.anomaly_detection_request import AnomalyDetectionRequest @@ -271,6 +279,10 @@ from gooddata_api_client.model.declarative_ldm import DeclarativeLdm from gooddata_api_client.model.declarative_memory_item import DeclarativeMemoryItem from gooddata_api_client.model.declarative_metric import DeclarativeMetric +from gooddata_api_client.model.declarative_metric_permission_assignment import DeclarativeMetricPermissionAssignment +from gooddata_api_client.model.declarative_metric_permission_for_assignee import DeclarativeMetricPermissionForAssignee +from gooddata_api_client.model.declarative_metric_permission_for_assignee_rule import DeclarativeMetricPermissionForAssigneeRule +from gooddata_api_client.model.declarative_metric_permissions_inner import DeclarativeMetricPermissionsInner 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_identifier import DeclarativeNotificationChannelIdentifier @@ -279,6 +291,9 @@ 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_publisher_document import DeclarativePublisherDocument +from gooddata_api_client.model.declarative_publisher_document_page_template import DeclarativePublisherDocumentPageTemplate +from gooddata_api_client.model.declarative_publisher_document_template import DeclarativePublisherDocumentTemplate 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_report import DeclarativeReport @@ -305,6 +320,10 @@ from gooddata_api_client.model.declarative_users import DeclarativeUsers from gooddata_api_client.model.declarative_users_user_groups import DeclarativeUsersUserGroups from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject +from gooddata_api_client.model.declarative_visualization_object_permission_assignment import DeclarativeVisualizationObjectPermissionAssignment +from gooddata_api_client.model.declarative_visualization_object_permission_for_assignee import DeclarativeVisualizationObjectPermissionForAssignee +from gooddata_api_client.model.declarative_visualization_object_permission_for_assignee_rule import DeclarativeVisualizationObjectPermissionForAssigneeRule +from gooddata_api_client.model.declarative_visualization_object_permissions_inner import DeclarativeVisualizationObjectPermissionsInner 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 @@ -401,7 +420,7 @@ from gooddata_api_client.model.geo_json_feature_collection import GeoJsonFeatureCollection from gooddata_api_client.model.geo_json_geometry import GeoJsonGeometry from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response -from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.get_document_export202_response_inner import GetDocumentExport202ResponseInner from gooddata_api_client.model.get_quality_issues_response import GetQualityIssuesResponse from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse from gooddata_api_client.model.grain_identifier import GrainIdentifier @@ -423,6 +442,10 @@ from gooddata_api_client.model.import_csv_response import ImportCsvResponse from gooddata_api_client.model.import_geo_collection_request import ImportGeoCollectionRequest from gooddata_api_client.model.import_geo_collection_response import ImportGeoCollectionResponse +from gooddata_api_client.model.import_sav_request import ImportSavRequest +from gooddata_api_client.model.import_sav_request_table import ImportSavRequestTable +from gooddata_api_client.model.import_sav_request_table_source import ImportSavRequestTableSource +from gooddata_api_client.model.import_sav_response import ImportSavResponse 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 @@ -976,6 +999,49 @@ from gooddata_api_client.model.json_api_parameter_post_optional_id import JsonApiParameterPostOptionalId from gooddata_api_client.model.json_api_parameter_post_optional_id_document import JsonApiParameterPostOptionalIdDocument from gooddata_api_client.model.json_api_parameter_to_many_linkage import JsonApiParameterToManyLinkage +from gooddata_api_client.model.json_api_publisher_document_in import JsonApiPublisherDocumentIn +from gooddata_api_client.model.json_api_publisher_document_in_attributes import JsonApiPublisherDocumentInAttributes +from gooddata_api_client.model.json_api_publisher_document_in_attributes_content import JsonApiPublisherDocumentInAttributesContent +from gooddata_api_client.model.json_api_publisher_document_in_attributes_period import JsonApiPublisherDocumentInAttributesPeriod +from gooddata_api_client.model.json_api_publisher_document_in_document import JsonApiPublisherDocumentInDocument +from gooddata_api_client.model.json_api_publisher_document_out import JsonApiPublisherDocumentOut +from gooddata_api_client.model.json_api_publisher_document_out_attributes import JsonApiPublisherDocumentOutAttributes +from gooddata_api_client.model.json_api_publisher_document_out_document import JsonApiPublisherDocumentOutDocument +from gooddata_api_client.model.json_api_publisher_document_out_list import JsonApiPublisherDocumentOutList +from gooddata_api_client.model.json_api_publisher_document_out_with_links import JsonApiPublisherDocumentOutWithLinks +from gooddata_api_client.model.json_api_publisher_document_page_template_in import JsonApiPublisherDocumentPageTemplateIn +from gooddata_api_client.model.json_api_publisher_document_page_template_in_attributes import JsonApiPublisherDocumentPageTemplateInAttributes +from gooddata_api_client.model.json_api_publisher_document_page_template_in_attributes_content import JsonApiPublisherDocumentPageTemplateInAttributesContent +from gooddata_api_client.model.json_api_publisher_document_page_template_in_document import JsonApiPublisherDocumentPageTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out import JsonApiPublisherDocumentPageTemplateOut +from gooddata_api_client.model.json_api_publisher_document_page_template_out_attributes import JsonApiPublisherDocumentPageTemplateOutAttributes +from gooddata_api_client.model.json_api_publisher_document_page_template_out_document import JsonApiPublisherDocumentPageTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_out_list import JsonApiPublisherDocumentPageTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_page_template_out_with_links import JsonApiPublisherDocumentPageTemplateOutWithLinks +from gooddata_api_client.model.json_api_publisher_document_page_template_patch import JsonApiPublisherDocumentPageTemplatePatch +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_attributes import JsonApiPublisherDocumentPageTemplatePatchAttributes +from gooddata_api_client.model.json_api_publisher_document_page_template_patch_document import JsonApiPublisherDocumentPageTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id import JsonApiPublisherDocumentPageTemplatePostOptionalId +from gooddata_api_client.model.json_api_publisher_document_page_template_post_optional_id_document import JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_patch import JsonApiPublisherDocumentPatch +from gooddata_api_client.model.json_api_publisher_document_patch_attributes import JsonApiPublisherDocumentPatchAttributes +from gooddata_api_client.model.json_api_publisher_document_patch_document import JsonApiPublisherDocumentPatchDocument +from gooddata_api_client.model.json_api_publisher_document_post_optional_id import JsonApiPublisherDocumentPostOptionalId +from gooddata_api_client.model.json_api_publisher_document_post_optional_id_document import JsonApiPublisherDocumentPostOptionalIdDocument +from gooddata_api_client.model.json_api_publisher_document_template_in import JsonApiPublisherDocumentTemplateIn +from gooddata_api_client.model.json_api_publisher_document_template_in_attributes import JsonApiPublisherDocumentTemplateInAttributes +from gooddata_api_client.model.json_api_publisher_document_template_in_attributes_content import JsonApiPublisherDocumentTemplateInAttributesContent +from gooddata_api_client.model.json_api_publisher_document_template_in_document import JsonApiPublisherDocumentTemplateInDocument +from gooddata_api_client.model.json_api_publisher_document_template_out import JsonApiPublisherDocumentTemplateOut +from gooddata_api_client.model.json_api_publisher_document_template_out_attributes import JsonApiPublisherDocumentTemplateOutAttributes +from gooddata_api_client.model.json_api_publisher_document_template_out_document import JsonApiPublisherDocumentTemplateOutDocument +from gooddata_api_client.model.json_api_publisher_document_template_out_list import JsonApiPublisherDocumentTemplateOutList +from gooddata_api_client.model.json_api_publisher_document_template_out_with_links import JsonApiPublisherDocumentTemplateOutWithLinks +from gooddata_api_client.model.json_api_publisher_document_template_patch import JsonApiPublisherDocumentTemplatePatch +from gooddata_api_client.model.json_api_publisher_document_template_patch_attributes import JsonApiPublisherDocumentTemplatePatchAttributes +from gooddata_api_client.model.json_api_publisher_document_template_patch_document import JsonApiPublisherDocumentTemplatePatchDocument +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id import JsonApiPublisherDocumentTemplatePostOptionalId +from gooddata_api_client.model.json_api_publisher_document_template_post_optional_id_document import JsonApiPublisherDocumentTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_report_in import JsonApiReportIn from gooddata_api_client.model.json_api_report_in_attributes import JsonApiReportInAttributes from gooddata_api_client.model.json_api_report_in_document import JsonApiReportInDocument @@ -1207,6 +1273,27 @@ 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.localization_content import LocalizationContent +from gooddata_api_client.model.localization_count import LocalizationCount +from gooddata_api_client.model.localization_data_statistics import LocalizationDataStatistics +from gooddata_api_client.model.localization_default import LocalizationDefault +from gooddata_api_client.model.localization_defaults import LocalizationDefaults +from gooddata_api_client.model.localization_metadata_statistics import LocalizationMetadataStatistics +from gooddata_api_client.model.localization_resolved_value import LocalizationResolvedValue +from gooddata_api_client.model.localization_resolved_values import LocalizationResolvedValues +from gooddata_api_client.model.localization_setting_usage import LocalizationSettingUsage +from gooddata_api_client.model.localization_setting_usages import LocalizationSettingUsages +from gooddata_api_client.model.localization_source_counts import LocalizationSourceCounts +from gooddata_api_client.model.localization_statistics import LocalizationStatistics +from gooddata_api_client.model.localization_statistics_locale import LocalizationStatisticsLocale +from gooddata_api_client.model.localization_usage import LocalizationUsage +from gooddata_api_client.model.localization_usage_user import LocalizationUsageUser +from gooddata_api_client.model.localization_usage_users import LocalizationUsageUsers +from gooddata_api_client.model.localization_usage_value import LocalizationUsageValue +from gooddata_api_client.model.localization_usage_workspace import LocalizationUsageWorkspace +from gooddata_api_client.model.localization_usage_workspaces import LocalizationUsageWorkspaces +from gooddata_api_client.model.localization_user_value import LocalizationUserValue +from gooddata_api_client.model.localization_user_values import LocalizationUserValues from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner from gooddata_api_client.model.manage_computed_attribute_permissions_request_inner import ManageComputedAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner @@ -1300,6 +1387,77 @@ from gooddata_api_client.model.profile_features import ProfileFeatures from gooddata_api_client.model.profile_links import ProfileLinks from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest +from gooddata_api_client.model.publisher_document_arbitrary_attribute_filter import PublisherDocumentArbitraryAttributeFilter +from gooddata_api_client.model.publisher_document_arbitrary_attribute_filter_arbitrary_attribute_filter import PublisherDocumentArbitraryAttributeFilterArbitraryAttributeFilter +from gooddata_api_client.model.publisher_document_area_style import PublisherDocumentAreaStyle +from gooddata_api_client.model.publisher_document_area_style_gap import PublisherDocumentAreaStyleGap +from gooddata_api_client.model.publisher_document_attribute_elements import PublisherDocumentAttributeElements +from gooddata_api_client.model.publisher_document_attribute_elements_by_uri import PublisherDocumentAttributeElementsByUri +from gooddata_api_client.model.publisher_document_attribute_elements_by_value import PublisherDocumentAttributeElementsByValue +from gooddata_api_client.model.publisher_document_attribute_filter import PublisherDocumentAttributeFilter +from gooddata_api_client.model.publisher_document_attribute_filter_attribute_filter import PublisherDocumentAttributeFilterAttributeFilter +from gooddata_api_client.model.publisher_document_attribute_filter_by_date import PublisherDocumentAttributeFilterByDate +from gooddata_api_client.model.publisher_document_attribute_filter_config import PublisherDocumentAttributeFilterConfig +from gooddata_api_client.model.publisher_document_attribute_filter_parent import PublisherDocumentAttributeFilterParent +from gooddata_api_client.model.publisher_document_attribute_filter_parent_over import PublisherDocumentAttributeFilterParentOver +from gooddata_api_client.model.publisher_document_attribute_filter_reference import PublisherDocumentAttributeFilterReference +from gooddata_api_client.model.publisher_document_auto_visibility import PublisherDocumentAutoVisibility +from gooddata_api_client.model.publisher_document_auto_visibility_visible import PublisherDocumentAutoVisibilityVisible +from gooddata_api_client.model.publisher_document_axis_display import PublisherDocumentAxisDisplay +from gooddata_api_client.model.publisher_document_axis_name_display import PublisherDocumentAxisNameDisplay +from gooddata_api_client.model.publisher_document_axis_values_display import PublisherDocumentAxisValuesDisplay +from gooddata_api_client.model.publisher_document_bounded_filter import PublisherDocumentBoundedFilter +from gooddata_api_client.model.publisher_document_chart_style import PublisherDocumentChartStyle +from gooddata_api_client.model.publisher_document_column import PublisherDocumentColumn +from gooddata_api_client.model.publisher_document_comparison_condition import PublisherDocumentComparisonCondition +from gooddata_api_client.model.publisher_document_container_style import PublisherDocumentContainerStyle +from gooddata_api_client.model.publisher_document_container_style_border_bottom_left_radius import PublisherDocumentContainerStyleBorderBottomLeftRadius +from gooddata_api_client.model.publisher_document_container_style_padding import PublisherDocumentContainerStylePadding +from gooddata_api_client.model.publisher_document_content import PublisherDocumentContent +from gooddata_api_client.model.publisher_document_data_set_ref import PublisherDocumentDataSetRef +from gooddata_api_client.model.publisher_document_date_filter import PublisherDocumentDateFilter +from gooddata_api_client.model.publisher_document_date_filter_date_filter import PublisherDocumentDateFilterDateFilter +from gooddata_api_client.model.publisher_document_date_filter_date_filter_from import PublisherDocumentDateFilterDateFilterFrom +from gooddata_api_client.model.publisher_document_date_filter_reference import PublisherDocumentDateFilterReference +from gooddata_api_client.model.publisher_document_defaults import PublisherDocumentDefaults +from gooddata_api_client.model.publisher_document_filter import PublisherDocumentFilter +from gooddata_api_client.model.publisher_document_filter_reference import PublisherDocumentFilterReference +from gooddata_api_client.model.publisher_document_heading_widget import PublisherDocumentHeadingWidget +from gooddata_api_client.model.publisher_document_headline_style import PublisherDocumentHeadlineStyle +from gooddata_api_client.model.publisher_document_image_widget import PublisherDocumentImageWidget +from gooddata_api_client.model.publisher_document_image_widget_style import PublisherDocumentImageWidgetStyle +from gooddata_api_client.model.publisher_document_layout_node import PublisherDocumentLayoutNode +from gooddata_api_client.model.publisher_document_legend_display import PublisherDocumentLegendDisplay +from gooddata_api_client.model.publisher_document_match_attribute_filter import PublisherDocumentMatchAttributeFilter +from gooddata_api_client.model.publisher_document_match_attribute_filter_match_attribute_filter import PublisherDocumentMatchAttributeFilterMatchAttributeFilter +from gooddata_api_client.model.publisher_document_measure_value_condition import PublisherDocumentMeasureValueCondition +from gooddata_api_client.model.publisher_document_measure_value_filter import PublisherDocumentMeasureValueFilter +from gooddata_api_client.model.publisher_document_measure_value_filter_dashboard_measure_value_filter import PublisherDocumentMeasureValueFilterDashboardMeasureValueFilter +from gooddata_api_client.model.publisher_document_measure_value_filter_reference import PublisherDocumentMeasureValueFilterReference +from gooddata_api_client.model.publisher_document_obj_ref import PublisherDocumentObjRef +from gooddata_api_client.model.publisher_document_page import PublisherDocumentPage +from gooddata_api_client.model.publisher_document_page_style import PublisherDocumentPageStyle +from gooddata_api_client.model.publisher_document_page_template_content import PublisherDocumentPageTemplateContent +from gooddata_api_client.model.publisher_document_period import PublisherDocumentPeriod +from gooddata_api_client.model.publisher_document_range_condition import PublisherDocumentRangeCondition +from gooddata_api_client.model.publisher_document_row import PublisherDocumentRow +from gooddata_api_client.model.publisher_document_section import PublisherDocumentSection +from gooddata_api_client.model.publisher_document_table_style import PublisherDocumentTableStyle +from gooddata_api_client.model.publisher_document_takeaway_context import PublisherDocumentTakeawayContext +from gooddata_api_client.model.publisher_document_takeaway_defaults import PublisherDocumentTakeawayDefaults +from gooddata_api_client.model.publisher_document_takeaway_generation import PublisherDocumentTakeawayGeneration +from gooddata_api_client.model.publisher_document_takeaway_widget import PublisherDocumentTakeawayWidget +from gooddata_api_client.model.publisher_document_text_style import PublisherDocumentTextStyle +from gooddata_api_client.model.publisher_document_text_widget import PublisherDocumentTextWidget +from gooddata_api_client.model.publisher_document_text_widget_style import PublisherDocumentTextWidgetStyle +from gooddata_api_client.model.publisher_document_title_widget import PublisherDocumentTitleWidget +from gooddata_api_client.model.publisher_document_visibility import PublisherDocumentVisibility +from gooddata_api_client.model.publisher_document_visualization_display import PublisherDocumentVisualizationDisplay +from gooddata_api_client.model.publisher_document_visualization_ref import PublisherDocumentVisualizationRef +from gooddata_api_client.model.publisher_document_visualization_style import PublisherDocumentVisualizationStyle +from gooddata_api_client.model.publisher_document_visualization_widget import PublisherDocumentVisualizationWidget +from gooddata_api_client.model.publisher_document_widget_placeholder import PublisherDocumentWidgetPlaceholder +from gooddata_api_client.model.publisher_document_widget_title import PublisherDocumentWidgetTitle from gooddata_api_client.model.quality_issue import QualityIssue from gooddata_api_client.model.quality_issue_object import QualityIssueObject from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse @@ -1325,6 +1483,8 @@ from gooddata_api_client.model.relative_bounded_date_filter import RelativeBoundedDateFilter from gooddata_api_client.model.relative_date_filter import RelativeDateFilter from gooddata_api_client.model.relative_date_filter_relative_date_filter import RelativeDateFilterRelativeDateFilter +from gooddata_api_client.model.relative_publisher_document_period import RelativePublisherDocumentPeriod +from gooddata_api_client.model.relative_publisher_document_period_all_of import RelativePublisherDocumentPeriodAllOf from gooddata_api_client.model.relative_wrapper import RelativeWrapper from gooddata_api_client.model.remove_database_data_source_response import RemoveDatabaseDataSourceResponse from gooddata_api_client.model.report_export_request import ReportExportRequest @@ -1451,6 +1611,7 @@ 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_localization_usage import WorkspaceLocalizationUsage from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment from gooddata_api_client.model.workspace_user import WorkspaceUser from gooddata_api_client.model.workspace_user_group import WorkspaceUserGroup diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 336d68381..0d6f0f7f1 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -932,6 +932,20 @@ "description": "Attribute name.", "type": "string" }, + "dataType": { + "description": "Data type of the attribute values, only filled for computed attributes.", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, "format": { "$ref": "#/components/schemas/AttributeFormat" }, @@ -996,6 +1010,10 @@ "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, + "numberFormat": { + "description": "Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format.", + "type": "string" + }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" }, @@ -1956,6 +1974,20 @@ "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", "type": "string" }, + "dataType": { + "description": "Data type of the element values, only filled for computed attributes.", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, "elements": { "description": "List of returned elements.", "items": { @@ -2012,6 +2044,10 @@ ], "type": "string" }, + "numberFormat": { + "description": "Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format.", + "type": "string" + }, "paging": { "$ref": "#/components/schemas/Paging" }, diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index 34ad9242e..7bb0cc87a 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -148,7 +148,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -243,6 +243,58 @@ ], "type": "object" }, + "AbsolutePublisherDocumentPeriod": { + "allOf": [ + { + "properties": { + "from": { + "description": "First day of the period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "granularity": { + "description": "Date granularity of the period.", + "enum": [ + "GDC.time.date" + ], + "example": "GDC.time.date", + "type": "string" + }, + "to": { + "description": "Last day of the period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "type": { + "description": "Type of the period.", + "enum": [ + "absolute" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A period between two dates.", + "properties": { + "type": { + "enum": [ + "absolute" + ], + "type": "string" + } + }, + "required": [ + "from", + "granularity", + "to", + "type" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -1237,6 +1289,130 @@ }, "type": "object" }, + "AnalyzeSavRequest": { + "description": "Bulk SPSS (.sav) file analysis request.", + "properties": { + "analyzeRequests": { + "description": "List of individual SPSS file analysis requests.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavRequestItem" + }, + "type": "array" + } + }, + "required": [ + "analyzeRequests" + ], + "type": "object" + }, + "AnalyzeSavRequestItem": { + "description": "SPSS (.sav) file analysis request.", + "properties": { + "config": { + "$ref": "#/components/schemas/AnalyzeSavRequestItemConfig" + }, + "location": { + "description": "Location of the SPSS file to analyze.", + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "AnalyzeSavRequestItemConfig": { + "description": "SPSS (.sav) file analysis request config.", + "properties": { + "resultRows": { + "description": "Number of rows to return as the preview of the file. The default is 100, the maximum is 1000.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AnalyzeSavResponse": { + "description": "Describes the results of an analysis of a single SPSS (.sav) file.", + "properties": { + "columns": { + "description": "List of column metadata.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponseColumn" + }, + "type": "array" + }, + "location": { + "description": "Location of the analyzed file in the source data source.", + "type": "string" + }, + "previewData": { + "description": "Preview of the first N rows of the file.", + "items": { + "description": "Preview of the first N rows of the file.", + "items": { + "description": "Preview of the first N rows of the file.", + "type": "object" + }, + "type": "array" + }, + "type": "array" + } + }, + "required": [ + "columns", + "location", + "previewData" + ], + "type": "object" + }, + "AnalyzeSavResponseColumn": { + "description": "Describes a column of an SPSS file.", + "properties": { + "label": { + "description": "Label of the column, in a survey file usually the question text. Null if there is none.", + "type": "string" + }, + "name": { + "description": "Name of the column as specified in the file.", + "type": "string" + }, + "type": { + "description": "Type of the column (e.g. string, float64, date32).", + "type": "string" + }, + "valueLabels": { + "description": "Labels of the column values in file order. Null if there are none.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponseValueLabel" + }, + "type": "array" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, + "AnalyzeSavResponseValueLabel": { + "description": "Label of one value of an SPSS column.", + "properties": { + "label": { + "description": "The label of the value, in a survey file usually the answer text.", + "type": "string" + }, + "value": { + "description": "The value: a number in a numeric column, a string in a string column.", + "type": "object" + } + }, + "required": [ + "label", + "value" + ], + "type": "object" + }, "AnalyzeStatisticsRequest": { "description": "Request to run ANALYZE TABLE for tables in a database instance", "properties": { @@ -1711,6 +1887,20 @@ "description": "Attribute name.", "type": "string" }, + "dataType": { + "description": "Data type of the attribute values, only filled for computed attributes.", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, "format": { "$ref": "#/components/schemas/AttributeFormat" }, @@ -1775,6 +1965,10 @@ "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, + "numberFormat": { + "description": "Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format.", + "type": "string" + }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" }, @@ -5183,7 +5377,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -5397,7 +5592,7 @@ "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "permissions": { - "description": "A list of permissions.", + "description": "A list of permissions. A PUT without this property removes all existing permissions.", "items": { "oneOf": [ { @@ -5601,6 +5796,20 @@ }, "type": "array" }, + "documentTemplates": { + "description": "A list of document templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocumentTemplate" + }, + "type": "array" + }, + "documents": { + "description": "A list of documents available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocument" + }, + "type": "array" + }, "exportDefinitions": { "description": "A list of export definitions.", "items": { @@ -5629,6 +5838,13 @@ }, "type": "array" }, + "pageTemplates": { + "description": "A list of page templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocumentPageTemplate" + }, + "type": "array" + }, "parameters": { "description": "A list of parameters available in the model.", "items": { @@ -6071,6 +6287,12 @@ "example": "INT", "type": "string" }, + "defaultLabelOf": { + "description": "(EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.", + "example": "gender", + "maxLength": 255, + "type": "string" + }, "description": { "description": "Column description/comment from database", "example": "Customer unique identifier", @@ -6503,6 +6725,11 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "name": { "description": "Name of the data source.", "example": "postgres demo", @@ -6577,7 +6804,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -7726,6 +7952,21 @@ "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "permissions": { + "description": "A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssigneeRule" + } + ] + }, + "nullable": true, + "type": "array" + }, "tags": { "description": "A list of tags.", "example": [ @@ -7753,6 +7994,67 @@ ], "type": "object" }, + "DeclarativeMetricPermissionAssignment": { + "description": "Metric permission.", + "nullable": true, + "properties": { + "name": { + "description": "Permission name.", + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "DeclarativeMetricPermissionForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionAssignment" + }, + { + "properties": { + "assignee": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Metric permission for an assignee.", + "required": [ + "assignee", + "name" + ], + "type": "object" + }, + "DeclarativeMetricPermissionForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Metric permission for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "name" + ], + "type": "object" + }, "DeclarativeModel": { "description": "A data model structured as a set of its attributes.", "properties": { @@ -8139,6 +8441,142 @@ ], "type": "object" }, + "DeclarativePublisherDocument": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentContent" + }, + "description": { + "description": "Document description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Document ID.", + "example": "levis-h1-2026", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "period": { + "$ref": "#/components/schemas/PublisherDocumentPeriod" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Document title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "period", + "title", + "version" + ], + "type": "object" + }, + "DeclarativePublisherDocumentPageTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentPageTemplateContent" + }, + "description": { + "description": "Page template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Page template ID.", + "example": "brand-cover", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Page template title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "title", + "version" + ], + "type": "object" + }, + "DeclarativePublisherDocumentTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentContent" + }, + "description": { + "description": "Document template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Document template ID.", + "example": "brand-review", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Document template title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "title", + "version" + ], + "type": "object" + }, "DeclarativeReference": { "description": "A dataset reference.", "properties": { @@ -8614,6 +9052,13 @@ }, "type": "array" }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.", + "type": "object" + }, "type": { "description": "Table type: TABLE or VIEW.", "example": "TABLE", @@ -9067,6 +9512,21 @@ "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "permissions": { + "description": "A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssigneeRule" + } + ] + }, + "nullable": true, + "type": "array" + }, "tags": { "description": "A list of tags.", "example": [ @@ -9094,6 +9554,67 @@ ], "type": "object" }, + "DeclarativeVisualizationObjectPermissionAssignment": { + "description": "Visualization object permission.", + "nullable": true, + "properties": { + "name": { + "description": "Permission name.", + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "DeclarativeVisualizationObjectPermissionForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionAssignment" + }, + { + "properties": { + "assignee": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Visualization object permission for an assignee.", + "required": [ + "assignee", + "name" + ], + "type": "object" + }, + "DeclarativeVisualizationObjectPermissionForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Visualization object permission for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "name" + ], + "type": "object" + }, "DeclarativeWorkspace": { "description": "A declarative form of a particular workspace.", "properties": { @@ -9975,6 +10496,20 @@ "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", "type": "string" }, + "dataType": { + "description": "Data type of the element values, only filled for computed attributes.", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, "elements": { "description": "List of returned elements.", "items": { @@ -10031,6 +10566,10 @@ ], "type": "string" }, + "numberFormat": { + "description": "Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format.", + "type": "string" + }, "paging": { "$ref": "#/components/schemas/Paging" }, @@ -11394,7 +11933,8 @@ "type": { "description": "Type of the file.", "enum": [ - "CSV" + "CSV", + "SAV" ], "type": "string" } @@ -11977,6 +12517,9 @@ "reportPageLayout", "reportTemplate", "report", + "pageTemplate", + "document", + "documentTemplate", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -12168,6 +12711,71 @@ ], "type": "object" }, + "ImportSavRequest": { + "description": "Request containing the information necessary to import one or more SPSS (.sav) files from the staging area.", + "properties": { + "tables": { + "description": "Information about the individual tables.", + "items": { + "$ref": "#/components/schemas/ImportSavRequestTable" + }, + "type": "array" + } + }, + "required": [ + "tables" + ], + "type": "object" + }, + "ImportSavRequestTable": { + "description": "Information about a particular table imported from an SPSS file.", + "properties": { + "name": { + "description": "Name of the table.", + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ImportSavRequestTableSource" + } + }, + "required": [ + "name", + "source" + ], + "type": "object" + }, + "ImportSavRequestTableSource": { + "description": "Information about the SPSS source data of a particular table.", + "properties": { + "location": { + "description": "Location of the data in the staging area.", + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "ImportSavResponse": { + "description": "Response containing the information about the imported SPSS (.sav) file.", + "properties": { + "name": { + "description": "Name of the table the file was imported to.", + "type": "string" + }, + "version": { + "description": "Version the file was imported as.", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "name", + "version" + ], + "type": "object" + }, "InPlatform": { "allOf": [ { @@ -12394,7 +13002,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -12551,7 +13160,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -12817,7 +13427,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -18799,7 +19410,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -18978,237 +19588,246 @@ "nullable": true, "type": "boolean" }, - "name": { - "description": "User-facing name of the data source.", - "maxLength": 255, - "type": "string" - }, - "parameters": { - "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "password": { - "description": "The password to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "privateKey": { - "description": "The private key to use to connect to the database providing the data for the data source.", - "maxLength": 15000, - "nullable": true, - "type": "string" - }, - "privateKeyPassphrase": { - "description": "The passphrase used to encrypt the private key.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "schema": { - "description": "The schema to use as the root of the data for the data source.", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of the database providing the data for the data source.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB", - "AILAKEHOUSE", - "DENODO", - "TRINO" - ], - "type": "string" - }, - "url": { - "description": "The URL of the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "username": { - "description": "The username to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "name", - "schema", - "type" - ], - "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": [ - "dataSource" - ], - "example": "dataSource", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiDataSourceInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourceIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceOut": { - "description": "JSON:API representation of dataSource entity.", - "properties": { - "attributes": { - "properties": { - "alternativeDataSourceId": { - "description": "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.", - "example": "pg_local_docker-demo2", + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", "nullable": true, - "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": [ - "ALWAYS", - "NEVER" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "dateTimeSemantics": { - "description": "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.", - "enum": [ - "LOCAL", - "UTC" - ], - "nullable": true, - "type": "string" - }, - "decodedParameters": { - "description": "Decoded parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "disableStatistics": { - "description": "Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.", - "nullable": true, - "type": "boolean" - }, - "managed": { - "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, + "name": { + "description": "User-facing name of the data source.", + "maxLength": 255, + "type": "string" + }, + "parameters": { + "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "password": { + "description": "The password to use to connect to the database providing the data for the data source.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "privateKey": { + "description": "The private key to use to connect to the database providing the data for the data source.", + "maxLength": 15000, + "nullable": true, + "type": "string" + }, + "privateKeyPassphrase": { + "description": "The passphrase used to encrypt the private key.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "schema": { + "description": "The schema to use as the root of the data for the data source.", + "maxLength": 255, + "type": "string" + }, + "token": { + "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "type": { + "description": "Type of the database providing the data for the data source.", + "enum": [ + "POSTGRESQL", + "REDSHIFT", + "VERTICA", + "SNOWFLAKE", + "ADS", + "BIGQUERY", + "MSSQL", + "PRESTO", + "DREMIO", + "AZURESQL", + "SYNAPSESQL", + "DATABRICKS", + "GDSTORAGE", + "CLICKHOUSE", + "MYSQL", + "MARIADB", + "ORACLE", + "PINOT", + "SINGLESTORE", + "MOTHERDUCK", + "FLEXCONNECT", + "STARROCKS", + "ATHENA", + "CRATEDB", + "AILAKEHOUSE", + "DENODO", + "TRINO" + ], + "type": "string" + }, + "url": { + "description": "The URL of the database providing the data for the data source.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "username": { + "description": "The username to use to connect to the database providing the data for the data source.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "name", + "schema", + "type" + ], + "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": [ + "dataSource" + ], + "example": "dataSource", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiDataSourceInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDataSourceIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiDataSourceOut": { + "description": "JSON:API representation of dataSource entity.", + "properties": { + "attributes": { + "properties": { + "alternativeDataSourceId": { + "description": "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.", + "example": "pg_local_docker-demo2", + "nullable": true, + "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": [ + "ALWAYS", + "NEVER" + ], + "nullable": true, + "type": "string" + }, + "clientId": { + "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "dateTimeSemantics": { + "description": "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.", + "enum": [ + "LOCAL", + "UTC" + ], + "nullable": true, + "type": "string" + }, + "decodedParameters": { + "description": "Decoded parameters to be used when connecting to the database providing the data for the data source.", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "disableStatistics": { + "description": "Whether to skip the collection of physical statistics from the database. Statistics are collected when this is false or unset.", + "nullable": true, + "type": "boolean" + }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", "type": "boolean" }, "name": { @@ -19267,7 +19886,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -19458,6 +20076,11 @@ "nullable": true, "type": "boolean" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -19538,7 +20161,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -28717,8 +29339,8 @@ }, "type": "array" }, - "JsonApiReportIn": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentIn": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -28726,263 +29348,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -28990,40 +29540,46 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" - }, - "tags": { - "items": { - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" }, - "type": "array" - }, - "title": { + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -29036,9 +29592,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -29049,10 +29605,10 @@ ], "type": "object" }, - "JsonApiReportInDocument": { + "JsonApiPublisherDocumentInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentIn" } }, "required": [ @@ -29060,8 +29616,8 @@ ], "type": "object" }, - "JsonApiReportOut": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentOut": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -29069,263 +29625,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -29349,17 +29833,24 @@ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -29371,18 +29862,17 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -29448,9 +29938,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -29461,10 +29951,10 @@ ], "type": "object" }, - "JsonApiReportOutDocument": { + "JsonApiPublisherDocumentOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOut" }, "included": { "description": "Included resources", @@ -29496,12 +29986,12 @@ ], "type": "object" }, - "JsonApiReportOutList": { + "JsonApiPublisherDocumentOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29539,18 +30029,18 @@ ], "type": "object" }, - "JsonApiReportOutWithLinks": { + "JsonApiPublisherDocumentOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportPageLayoutIn": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplateIn": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -29558,132 +30048,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -29699,11 +30193,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -29716,9 +30216,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -29729,10 +30229,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutInDocument": { + "JsonApiPublisherDocumentPageTemplateInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateIn" } }, "required": [ @@ -29740,8 +30240,8 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOut": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplateOut": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -29749,132 +30249,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "createdAt": { @@ -29906,11 +30410,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -29976,9 +30486,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -29989,10 +30499,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutDocument": { + "JsonApiPublisherDocumentPageTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOut" }, "included": { "description": "Included resources", @@ -30024,12 +30534,12 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutList": { + "JsonApiPublisherDocumentPageTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30067,18 +30577,18 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutWithLinks": { + "JsonApiPublisherDocumentPageTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportPageLayoutPatch": { - "description": "JSON:API representation of patching reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplatePatch": { + "description": "JSON:API representation of patching pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -30086,132 +30596,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -30227,6 +30741,11 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "type": "object" @@ -30240,9 +30759,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -30253,10 +30772,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPatchDocument": { + "JsonApiPublisherDocumentPageTemplatePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatch" } }, "required": [ @@ -30264,8 +30783,8 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPostOptionalId": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplatePostOptionalId": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -30273,132 +30792,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -30414,11 +30937,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -30431,9 +30960,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -30443,10 +30972,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPostOptionalIdDocument": { + "JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalId" } }, "required": [ @@ -30454,8 +30983,8 @@ ], "type": "object" }, - "JsonApiReportPatch": { - "description": "JSON:API representation of patching report entity.", + "JsonApiPublisherDocumentPatch": { + "description": "JSON:API representation of patching document entity.", "properties": { "attributes": { "properties": { @@ -30463,263 +30992,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -30727,17 +31184,24 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -30749,11 +31213,10 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "type": "object" @@ -30767,9 +31230,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -30780,10 +31243,10 @@ ], "type": "object" }, - "JsonApiReportPatchDocument": { + "JsonApiPublisherDocumentPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPatch" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatch" } }, "required": [ @@ -30791,8 +31254,8 @@ ], "type": "object" }, - "JsonApiReportPostOptionalId": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentPostOptionalId": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -30800,263 +31263,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -31064,17 +31455,24 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -31086,18 +31484,17 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -31110,9 +31507,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -31122,10 +31519,10 @@ ], "type": "object" }, - "JsonApiReportPostOptionalIdDocument": { + "JsonApiPublisherDocumentPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPostOptionalId" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalId" } }, "required": [ @@ -31133,8 +31530,8 @@ ], "type": "object" }, - "JsonApiReportTemplateIn": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiPublisherDocumentTemplateIn": { + "description": "JSON:API representation of documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -31142,244 +31539,191 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 9 - }, - { - "children": [ - { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -31396,11 +31740,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -31413,9 +31763,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "documentTemplate" ], - "example": "reportTemplate", + "example": "documentTemplate", "type": "string" } }, @@ -31426,10 +31776,10 @@ ], "type": "object" }, - "JsonApiReportTemplateInDocument": { + "JsonApiPublisherDocumentTemplateInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplateIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateIn" } }, "required": [ @@ -31437,8 +31787,8 @@ ], "type": "object" }, - "JsonApiReportTemplateOut": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiPublisherDocumentTemplateOut": { + "description": "JSON:API representation of documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -31446,244 +31796,191 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -31716,11 +32013,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -31786,9 +32089,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "documentTemplate" ], - "example": "reportTemplate", + "example": "documentTemplate", "type": "string" } }, @@ -31799,10 +32102,10 @@ ], "type": "object" }, - "JsonApiReportTemplateOutDocument": { + "JsonApiPublisherDocumentTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplateOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOut" }, "included": { "description": "Included resources", @@ -31834,12 +32137,12 @@ ], "type": "object" }, - "JsonApiReportTemplateOutList": { + "JsonApiPublisherDocumentTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31877,18 +32180,18 @@ ], "type": "object" }, - "JsonApiReportTemplateOutWithLinks": { + "JsonApiPublisherDocumentTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportTemplateOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportTemplatePatch": { - "description": "JSON:API representation of patching reportTemplate entity.", + "JsonApiPublisherDocumentTemplatePatch": { + "description": "JSON:API representation of patching documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -31896,128 +32199,654 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_summary", - "type": "slotRef", + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "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": [ + "documentTemplate" + ], + "example": "documentTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePostOptionalId": { + "description": "JSON:API representation of documentTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", + "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], + "pages": [ + { + "id": "page_7f3a91c4", + "kind": "cover", + "layout": { + "children": [ + { + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" + }, + { + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } + }, + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" + }, + { + "children": [ + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } + }, + { + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "title", + "version" + ], + "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": [ + "documentTemplate" + ], + "example": "documentTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportIn": { + "description": "JSON:API representation of report entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", "weight": 1 } ], @@ -32087,8 +32916,9 @@ }, { "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" }, "style": { "type": "normalText" @@ -32141,6 +32971,18 @@ "maxLength": 10000, "type": "string" }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, "tags": { "items": { "type": "string" @@ -32150,8 +32992,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], "type": "object" }, "id": { @@ -32163,9 +33017,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "report" ], - "example": "reportTemplate", + "example": "report", "type": "string" } }, @@ -32176,10 +33030,10 @@ ], "type": "object" }, - "JsonApiReportTemplatePatchDocument": { + "JsonApiReportInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplatePatch" + "$ref": "#/components/schemas/JsonApiReportIn" } }, "required": [ @@ -32187,8 +33041,8 @@ ], "type": "object" }, - "JsonApiReportTemplatePostOptionalId": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiReportOut": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { @@ -32196,8 +33050,26 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], "pages": [ { "format": "widescreen", @@ -32387,8 +33259,9 @@ }, { "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" }, "style": { "type": "normalText" @@ -32437,10 +33310,38 @@ }, "type": "object" }, + "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, "type": "string" }, + "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" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, "tags": { "items": { "type": "string" @@ -32450,10 +33351,18 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "required": [ "content", + "periodEnd", + "periodStart", "title" ], "type": "object" @@ -32464,119 +33373,65 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "reportTemplate" - ], - "example": "reportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiReportTemplatePostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeIn": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { + "meta": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" - }, - "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": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemeInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemeIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeOut": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { + "relationships": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], "type": "object" }, - "name": { - "maxLength": 255, - "type": "string" + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, - "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": [ - "theme" + "report" ], - "example": "theme", + "example": "report", "type": "string" } }, @@ -32587,13 +33442,34 @@ ], "type": "object" }, - "JsonApiThemeOutDocument": { + "JsonApiReportOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiThemeOut" + "$ref": "#/components/schemas/JsonApiReportOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" } }, "required": [ @@ -32601,12 +33477,20 @@ ], "type": "object" }, - "JsonApiThemeOutList": { + "JsonApiReportOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -32618,6 +33502,14 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true } }, "type": "object" @@ -32628,31 +33520,172 @@ ], "type": "object" }, - "JsonApiThemeOutWithLinks": { + "JsonApiReportOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiThemeOut" + "$ref": "#/components/schemas/JsonApiReportOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiThemePatch": { - "description": "JSON:API representation of patching theme entity.", + "JsonApiReportPageLayoutIn": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { + "areRelationsValid": { + "type": "boolean" + }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, "type": "object" }, - "name": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -32664,9 +33697,9 @@ "type": { "description": "Object type", "enum": [ - "theme" + "reportPageLayout" ], - "example": "theme", + "example": "reportPageLayout", "type": "string" } }, @@ -32677,10 +33710,10 @@ ], "type": "object" }, - "JsonApiThemePatchDocument": { + "JsonApiReportPageLayoutInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiThemePatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" } }, "required": [ @@ -32688,20 +33721,161 @@ ], "type": "object" }, - "JsonApiUserDataFilterIn": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportPageLayoutOut": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, + "type": "object" + }, + "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, "type": "string" }, - "maql": { - "maxLength": 10000, + "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" }, "tags": { @@ -32716,7 +33890,8 @@ } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -32726,12 +33901,38 @@ "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" + }, "relationships": { "properties": { - "user": { + "createdBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -32739,10 +33940,10 @@ ], "type": "object" }, - "userGroup": { + "modifiedBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -32756,9 +33957,9 @@ "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -32769,210 +33970,15 @@ ], "type": "object" }, - "JsonApiUserDataFilterInDocument": { + "JsonApiReportPageLayoutOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterOut": { - "description": "JSON:API representation of userDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "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" - }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "computedAttributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "parameters": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserDataFilterOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -32999,43 +34005,12 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - } - ] - }, - "JsonApiUserDataFilterOutList": { + "JsonApiReportPageLayoutOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33043,7 +34018,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33073,29 +34048,154 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutWithLinks": { + "JsonApiReportPageLayoutOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserDataFilterPatch": { - "description": "JSON:API representation of patching userDataFilter entity.", + "JsonApiReportPageLayoutPatch": { + "description": "JSON:API representation of patching reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, + "type": "object" }, - "maql": { + "description": { "maxLength": 10000, "type": "string" }, @@ -33118,39 +34218,12 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -33161,10 +34234,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPatchDocument": { + "JsonApiReportPageLayoutPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" } }, "required": [ @@ -33172,150 +34245,189 @@ ], "type": "object" }, - "JsonApiUserDataFilterPostOptionalId": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportPageLayoutPostOptionalId": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiUserDataFilterPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserGroupIn": { - "description": "JSON:API representation of userGroup entity.", - "properties": { - "attributes": { - "properties": { - "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" - }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" }, - "required": [ - "data" - ], "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" } }, + "required": [ + "content", + "title" + ], "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": [ - "userGroup" + "reportPageLayout" ], - "example": "userGroup", + "example": "reportPageLayout", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserGroupInDocument": { + "JsonApiReportPageLayoutPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupIn" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" } }, "required": [ @@ -33323,33 +34435,306 @@ ], "type": "object" }, - "JsonApiUserGroupLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "userGroup" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserGroupOut": { - "description": "JSON:API representation of userGroup entity.", + "JsonApiReportPatch": { + "description": "JSON:API representation of patching report entity.", "properties": { "attributes": { "properties": { - "name": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "type": "object" @@ -33360,46 +34745,6398 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "userGroup" + "report" ], - "example": "userGroup", + "example": "report", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserGroupOutDocument": { + "JsonApiReportPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupOut" - }, - "included": { + "$ref": "#/components/schemas/JsonApiReportPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportPostOptionalId": { + "description": "JSON:API representation of report entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } + } + }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], + "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": [ + "report" + ], + "example": "report", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiReportPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateIn": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOut": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "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, + "type": "string" + }, + "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" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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" + }, + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplateOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplateOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" + }, + "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" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiReportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiReportTemplatePatch": { + "description": "JSON:API representation of patching reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplatePostOptionalId": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeIn": { + "description": "JSON:API representation of theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemeInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemeIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOut": { + "description": "JSON:API representation of theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemeOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemeOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiThemePatch": { + "description": "JSON:API representation of patching theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterIn": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOut": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "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" + }, + "relationships": { + "properties": { + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "labels": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + } + ] + }, + "JsonApiUserDataFilterOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserDataFilterPatch": { + "description": "JSON:API representation of patching userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 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": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterPostOptionalId": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupIn": { + "description": "JSON:API representation of userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userGroup" + ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "userGroup" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupOut": { + "description": "JSON:API representation of userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userGroup" + ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserGroupOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserGroupPatch": { + "description": "JSON:API representation of patching userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userGroup" + ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + }, + "type": "array" + }, + "JsonApiUserGroupToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + } + ] + }, + "JsonApiUserIdentifierLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "userIdentifier" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserIdentifierOut": { + "description": "JSON:API representation of userIdentifier entity.", + "properties": { + "attributes": { + "properties": { + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "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": [ + "userIdentifier" + ], + "example": "userIdentifier", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserIdentifierOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserIdentifierOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "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" + }, + "JsonApiUserIdentifierOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserIdentifierToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" + } + ] + }, + "JsonApiUserIn": { + "description": "JSON:API representation of user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "user" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserOut": { + "description": "JSON:API representation of user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserPatch": { + "description": "JSON:API representation of patching user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingIn": { + "description": "JSON:API representation of userSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "userSetting" + ], + "example": "userSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOut": { + "description": "JSON:API representation of userSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "userSetting" + ], + "example": "userSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiUserLinkage" + }, + "type": "array" + }, + "JsonApiUserToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserLinkage" + } + ] + }, + "JsonApiVisualizationObjectIn": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "visualizationObject" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOut": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "certification": { + "description": "Certification status of the entity.", + "enum": [ + "CERTIFIED" + ], + "type": "string" + }, + "certificationMessage": { + "description": "Optional message associated with the certification.", + "nullable": true, + "type": "string" + }, + "certifiedAt": { + "description": "Time when the certification was set.", + "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" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "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, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "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" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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" + }, + "permissions": { + "description": "List of valid permissions for a logged-in user.", + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "labels": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiVisualizationObjectPatch": { + "description": "JSON:API representation of patching visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPostOptionalId": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" + }, + "type": "array" + }, + "JsonApiVisualizationObjectToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" + } + ] + }, + "JsonApiWorkspaceAutomationOut": { + "description": "JSON:API representation of workspaceAutomation entity.", + "properties": { + "attributes": { + "properties": { + "alert": { + "properties": { + "condition": { + "$ref": "#/components/schemas/AlertCondition" + }, + "execution": { + "$ref": "#/components/schemas/AlertAfm" + }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "trigger": { + "default": "ALWAYS", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum": [ + "ALWAYS", + "ONCE", + "ONCE_PER_INTERVAL" + ], + "type": "string" + } + }, + "required": [ + "condition", + "execution" + ], + "type": "object" + }, + "areRelationsValid": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "dashboardTabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "details": { + "description": "Additional details to be included in the automated message.", + "maxLength": 10000, + "type": "object" + }, + "evaluationMode": { + "description": "Specify automation evaluation mode.", + "enum": [ + "SHARED", + "PER_RECIPIENT" + ], + "type": "string" + }, + "externalRecipients": { + "description": "External recipients of the automation action results.", + "items": { + "properties": { + "email": { + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object" + }, + "type": "array" + }, + "imageExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/ImageExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": true, + "description": "Additional information for the automation.", + "maxLength": 250000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, + "modifiedAt": { + "format": "date-time", + "type": "string" + }, + "rawExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/RawExportAutomationRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "schedule": { + "properties": { + "cron": { + "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example": "0 */30 9-17 ? * MON-FRI", + "maxLength": 255, + "type": "string" + }, + "cronDescription": { + "description": "Human-readable description of the cron expression.", + "readOnly": true, + "type": "string" + }, + "firstRun": { + "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example": "2025-01-01T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "timezone": { + "description": "Timezone in which the schedule is defined.", + "example": "Europe/Prague", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "cron", + "timezone" + ], + "type": "object" + }, + "slidesExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/SlidesExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Current state of the automation.", + "enum": [ + "ACTIVE", + "PAUSED" + ], + "type": "string" + }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "analyticalDashboard": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "automationResults": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "exportDefinitions": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "notificationChannel": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "recipients": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "workspace": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceAutomation" + ], + "example": "workspaceAutomation", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + } + ] + }, + "JsonApiWorkspaceAutomationOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "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": { + "attributes": { + "properties": { + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 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": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilter" + ], + "example": "workspaceDataFilter", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "workspaceDataFilter" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterOut": { + "description": "JSON:API representation of workspaceDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "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" + }, + "relationships": { + "properties": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilter" + ], + "example": "workspaceDataFilter", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceDataFilterPatch": { + "description": "JSON:API representation of patching workspaceDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 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": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilter" + ], + "example": "workspaceDataFilter", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingIn": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 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": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "workspaceDataFilterSetting" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingOut": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "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" + }, + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceDataFilterSettingPatch": { + "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 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": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" + }, + "type": "array" + }, + "JsonApiWorkspaceDataFilterToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + }, + "type": "array" + }, + "JsonApiWorkspaceDataFilterToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + } + ] + }, + "JsonApiWorkspaceExportTemplateIn": { + "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", + "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, + "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" + }, + "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": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching 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" + } + }, + "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" + }, + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", + "items": { + "maxLength": 255, + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, + "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" + }, + "meta": { + "properties": { + "config": { + "properties": { + "approximateCountAvailable": { + "default": false, + "description": "is approximate count enabled - based on type of data-source connected to this workspace", + "type": "boolean" + }, + "dataSamplingAvailable": { + "default": false, + "description": "is sampling enabled - based on type of data-source connected to this workspace", + "type": "boolean" + }, + "showAllValuesOnDatesAvailable": { + "default": false, + "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", + "type": "boolean" + } + }, + "type": "object" + }, + "dataModel": { + "properties": { + "datasetCount": { + "description": "include the number of dataset of each workspace", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "datasetCount" + ], + "type": "object" + }, + "hierarchy": { + "properties": { + "childrenCount": { + "description": "include the number of direct children of each workspace", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "childrenCount" + ], + "type": "object" + }, + "permissions": { + "description": "List of valid permissions for a logged-in user.", + "items": { + "enum": [ + "MANAGE", + "ANALYZE", + "EXPORT", + "EXPORT_TABULAR", + "EXPORT_PDF", + "CREATE_AUTOMATION", + "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", + "CREATE_FILTER_VIEW", + "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", + "CREATE_VISUALIZATION", + "CREATE_COMPUTED_ATTRIBUTE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "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" + }, + "JsonApiWorkspaceOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceOut" + }, + "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33426,12 +41163,12 @@ ], "type": "object" }, - "JsonApiUserGroupOutList": { + "JsonApiWorkspaceOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33439,7 +41176,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33469,23 +41206,79 @@ ], "type": "object" }, - "JsonApiUserGroupOutWithLinks": { + "JsonApiWorkspaceOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserGroupPatch": { - "description": "JSON:API representation of patching userGroup entity.", + "JsonApiWorkspacePatch": { + "description": "JSON:API representation of patching 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" } }, @@ -33499,10 +41292,10 @@ }, "relationships": { "properties": { - "parents": { + "parent": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ @@ -33516,9 +41309,9 @@ "type": { "description": "Object type", "enum": [ - "userGroup" + "workspace" ], - "example": "userGroup", + "example": "workspace", "type": "string" } }, @@ -33528,10 +41321,10 @@ ], "type": "object" }, - "JsonApiUserGroupPatchDocument": { + "JsonApiWorkspacePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupPatch" + "$ref": "#/components/schemas/JsonApiWorkspacePatch" } }, "required": [ @@ -33539,32 +41332,379 @@ ], "type": "object" }, - "JsonApiUserGroupToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + "JsonApiWorkspaceSettingIn": { + "description": "JSON:API representation of workspaceSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "workspaceSetting" + ], + "example": "workspaceSetting", + "type": "string" + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, - "JsonApiUserGroupToOneLinkage": { - "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, - "oneOf": [ + "JsonApiWorkspaceSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingOut": { + "description": "JSON:API representation of workspaceSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "type": "string" + } + }, + "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": [ + "workspaceSetting" + ], + "example": "workspaceSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingOutWithLinks": { + "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserIdentifierLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "JsonApiWorkspaceSettingPatch": { + "description": "JSON:API representation of patching workspaceSetting entity.", "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ - "userIdentifier" + "workspaceSetting" ], + "example": "workspaceSetting", "type": "string" } }, @@ -33574,21 +41714,89 @@ ], "type": "object" }, - "JsonApiUserIdentifierOut": { - "description": "JSON:API representation of userIdentifier entity.", + "JsonApiWorkspaceSettingPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingPostOptionalId": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { "attributes": { "properties": { - "email": { - "maxLength": 255, - "type": "string" - }, - "firstname": { - "maxLength": 255, - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "lastname": { - "maxLength": 255, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], "type": "string" } }, @@ -33603,52 +41811,21 @@ "type": { "description": "Object type", "enum": [ - "userIdentifier" + "workspaceSetting" ], - "example": "userIdentifier", + "example": "workspaceSetting", "type": "string" } }, "required": [ - "id", "type" ], "type": "object" }, - "JsonApiUserIdentifierOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserIdentifierOutList": { - "description": "A JSON:API document with a list of resources", + "JsonApiWorkspaceSettingPostOptionalIdDocument": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" } }, "required": [ @@ -33656,52 +41833,25 @@ ], "type": "object" }, - "JsonApiUserIdentifierOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiUserIdentifierToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" - } - ] - }, - "JsonApiUserIn": { - "description": "JSON:API representation of user entity.", + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, - "type": "string" - }, - "firstname": { - "maxLength": 255, - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "lastname": { + "name": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -33710,41 +41860,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "user" + "workspaceTheme" ], - "example": "user", + "example": "workspaceTheme", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserInDocument": { + "JsonApiWorkspaceThemeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIn" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" } }, "required": [ @@ -33752,52 +41887,25 @@ ], "type": "object" }, - "JsonApiUserLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "user" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserOut": { - "description": "JSON:API representation of user entity.", + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, - "type": "string" - }, - "firstname": { - "maxLength": 255, - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "lastname": { + "name": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -33806,16 +41914,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "userGroups": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "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" } @@ -33825,46 +41943,26 @@ "type": { "description": "Object type", "enum": [ - "user" + "workspaceTheme" ], - "example": "user", + "example": "workspaceTheme", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserOutDocument": { + "JsonApiWorkspaceThemeOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" - }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" } }, "required": [ @@ -33872,20 +41970,12 @@ ], "type": "object" }, - "JsonApiUserOutList": { + "JsonApiWorkspaceThemeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" }, "type": "array", "uniqueItems": true @@ -33897,14 +41987,6 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true } }, "type": "object" @@ -33915,41 +41997,29 @@ ], "type": "object" }, - "JsonApiUserOutWithLinks": { + "JsonApiWorkspaceThemeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserPatch": { - "description": "JSON:API representation of patching user entity.", + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, - "type": "string" - }, - "firstname": { - "maxLength": 255, - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "lastname": { + "name": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -33960,41 +42030,183 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" + } + ] + }, + "JsonNode": { + "description": "Free-form JSON object", + "example": {}, + "maxLength": 15000, + "nullable": true, + "type": "object" + }, + "KeyDriversDimension": { + "properties": { + "attribute": { + "$ref": "#/components/schemas/RestApiIdentifier" + }, + "attributeName": { + "type": "string" + }, + "format": { + "$ref": "#/components/schemas/AttributeFormat" + }, + "granularity": { + "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" + ], + "type": "string" + }, + "label": { + "$ref": "#/components/schemas/RestApiIdentifier" + }, + "labelName": { + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" + } + }, + "required": [ + "attribute", + "attributeName", + "label", + "labelName" + ], + "type": "object" + }, + "KeyDriversRequest": { + "properties": { + "auxMetrics": { + "description": "Additional metrics to be included in the computation, but excluded from the analysis.", + "items": { + "$ref": "#/components/schemas/MeasureItem" }, - "type": "object" + "type": "array" + }, + "metric": { + "$ref": "#/components/schemas/MeasureItem" }, - "type": { - "description": "Object type", + "sortDirection": { + "default": "DESC", + "description": "Sorting elements - ascending/descending order.", "enum": [ - "user" + "ASC", + "DESC" ], - "example": "user", "type": "string" } }, "required": [ - "id", - "type" + "metric" ], "type": "object" }, - "JsonApiUserPatchDocument": { + "KeyDriversResponse": { + "properties": { + "dimensions": { + "items": { + "$ref": "#/components/schemas/KeyDriversDimension" + }, + "type": "array" + }, + "links": { + "$ref": "#/components/schemas/ExecutionLinks" + } + }, + "required": [ + "dimensions", + "links" + ], + "type": "object" + }, + "KeyDriversResult": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserPatch" + "type": "object" } }, "required": [ @@ -34002,95 +42214,21 @@ ], "type": "object" }, - "JsonApiUserSettingIn": { - "description": "JSON:API representation of userSetting entity.", + "LabelIdentifier": { + "description": "A label identifier.", "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" - } - }, - "type": "object" - }, "id": { - "description": "API identifier of an object", - "example": "id1", + "description": "Label ID.", + "example": "label_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { - "description": "Object type", + "description": "A type of the label.", "enum": [ - "userSetting" + "label" ], - "example": "userSetting", + "example": "label", "type": "string" } }, @@ -34100,6258 +42238,6266 @@ ], "type": "object" }, - "JsonApiUserSettingInDocument": { + "LabelPermissions": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" + "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": [ - "data" + "rules", + "userGroups", + "users" ], "type": "object" }, - "JsonApiUserSettingOut": { - "description": "JSON:API representation of userSetting entity.", + "LabelPermissionsAssignment": { + "description": "Desired levels of permissions on a label for an assignee.", "properties": { - "attributes": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "LabelPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" + }, + { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, "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": [ - "userSetting" - ], - "example": "userSetting", - "type": "string" } - }, + ], + "description": "Desired levels of label permissions for an assignee identified by an identifier.", "required": [ - "id", - "type" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "JsonApiUserSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "LabelPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" }, - "links": { + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "ListLinks": { + "allOf": [ + { "$ref": "#/components/schemas/ObjectLinks" + }, + { + "properties": { + "next": { + "description": "A string containing the link's URL for the next page of data.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ListLlmProviderModelsRequest": { + "properties": { + "providerConfig": { + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ - "data" + "providerConfig" ], "type": "object" }, - "JsonApiUserSettingOutList": { - "description": "A JSON:API document with a list of resources", + "ListLlmProviderModelsResponse": { "properties": { - "data": { + "message": { + "description": "Message about the listing result.", + "type": "string" + }, + "models": { + "description": "Available models on the provider.", "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + "$ref": "#/components/schemas/LlmModel" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "success": { + "description": "Whether the model listing succeeded.", + "type": "boolean" + } + }, + "required": [ + "message", + "models", + "success" + ], + "type": "object" + }, + "LiveFeatureFlagConfiguration": { + "properties": { + "host": { + "type": "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "key": { + "type": "string" } }, "required": [ - "data" + "host", + "key" ], "type": "object" }, - "JsonApiUserSettingOutWithLinks": { + "LiveFeatures": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "$ref": "#/components/schemas/Features" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" + "properties": { + "configuration": { + "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" + } + }, + "type": "object" } - ] + ], + "description": "Structure for featureHub", + "required": [ + "configuration", + "context" + ], + "type": "object" }, - "JsonApiUserToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserLinkage" + "LlmModel": { + "description": "LLM Model configuration (id, family) within a provider.", + "properties": { + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE", + "UNKNOWN" + ], + "type": "string" + }, + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, + "type": "string" + } }, - "type": "array" + "required": [ + "family", + "id" + ], + "type": "object" }, - "JsonApiUserToOneLinkage": { - "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, + "LlmProviderConfig": { + "description": "Provider configuration overrides.", "oneOf": [ { - "$ref": "#/components/schemas/JsonApiUserLinkage" + "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" } ] }, - "JsonApiVisualizationObjectIn": { - "description": "JSON:API representation of visualizationObject entity.", + "LocalIdentifier": { "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, - "properties": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" - }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" - }, - "type": "array" - } - }, - "required": [ - "enabled", - "rules" - ], - "type": "object" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "format": { + "default": "#,##0.00", + "description": "Metric format.", + "example": "#,##0", + "maxLength": 2048, + "nullable": true, "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "visualizationObject" - ], - "example": "visualizationObject", + "localIdentifier": { + "description": "Local identifier of the metric to be compared.", + "example": "m1", + "type": "string" + }, + "title": { + "description": "Metric title.", + "example": "Revenue", + "maxLength": 255, + "nullable": true, "type": "string" } }, "required": [ - "attributes", - "id", - "type" + "localIdentifier" ], "type": "object" }, - "JsonApiVisualizationObjectInDocument": { + "LocaleRequest": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + "locale": { + "description": "Requested locale in the form of language tag (see RFC 5646).", + "example": "en-US", + "type": "string" } }, "required": [ - "data" + "locale" ], "type": "object" }, - "JsonApiVisualizationObjectLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "LocalizationContent": { "properties": { - "id": { + "value": { + "description": "Language tag, or null when no language is set.", + "example": "de-DE", + "nullable": true, "type": "string" + } + }, + "type": "object" + }, + "LocalizationCount": { + "properties": { + "bySource": { + "$ref": "#/components/schemas/LocalizationSourceCounts" }, - "type": { + "total": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "bySource", + "total" + ], + "type": "object" + }, + "LocalizationDataStatistics": { + "description": "Translations of labels in the logical data model. `locales` lists the languages with at least one label translation, sorted. Language tags do not include extensions.", + "properties": { + "locales": { + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsLocale" + }, + "type": "array" + } + }, + "required": [ + "locales" + ], + "type": "object" + }, + "LocalizationDefault": { + "description": "The value a workspace gets for one setting when it and its parents set nothing, and where it comes from. Null when that value has no language.", + "nullable": true, + "properties": { + "content": { + "$ref": "#/components/schemas/LocalizationContent" + }, + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "visualizationObject" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], "type": "string" } }, "required": [ - "id", - "type" + "content", + "source" ], "type": "object" }, - "JsonApiVisualizationObjectOut": { - "description": "JSON:API representation of visualizationObject entity.", + "LocalizationDefaults": { "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "certification": { - "description": "Certification status of the entity.", - "enum": [ - "CERTIFIED" - ], - "type": "string" - }, - "certificationMessage": { - "description": "Optional message associated with the certification.", - "nullable": true, - "type": "string" - }, - "certifiedAt": { - "description": "Time when the certification was set.", - "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" - }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, - "properties": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" - }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" - }, - "type": "array" - } - }, - "required": [ - "enabled", - "rules" - ], - "type": "object" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "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, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" }, - "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" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" + } + }, + "type": "object" + }, + "LocalizationMetadataStatistics": { + "description": "Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.", + "properties": { + "locales": { + "items": { + "$ref": "#/components/schemas/LocalizationStatisticsLocale" }, - "type": "object" + "type": "array" + } + }, + "required": [ + "locales" + ], + "type": "object" + }, + "LocalizationResolvedValue": { + "description": "The value a workspace gets for one setting, and where it comes from. Never null. `content.value` is null when the workspace gets no language.", + "properties": { + "content": { + "$ref": "#/components/schemas/LocalizationContent" }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "certifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "computedAttributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "parameters": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "originId": { + "description": "The ancestor workspace that sets the value. Null unless the source is PARENT.", + "nullable": true, + "type": "string" }, - "type": { - "description": "Object type", + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "visualizationObject" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], - "example": "visualizationObject", "type": "string" } }, "required": [ - "attributes", - "id", - "type" + "content", + "source" ], "type": "object" }, - "JsonApiVisualizationObjectOutDocument": { + "LocalizationResolvedValues": { + "description": "The value for each of the display, metadata and data language settings, with its source.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" - }, - "type": "array", - "uniqueItems": true + "LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" + } + }, + "required": [ + "DATA_LOCALE", + "LOCALE", + "METADATA_LOCALE" + ], + "type": "object" + }, + "LocalizationSettingUsage": { + "properties": { + "users": { + "$ref": "#/components/schemas/LocalizationCount" }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "workspaces": { + "$ref": "#/components/schemas/LocalizationCount" } }, "required": [ - "data" + "users", + "workspaces" ], "type": "object" }, - "JsonApiVisualizationObjectOutList": { - "description": "A JSON:API document with a list of resources", + "LocalizationSettingUsages": { + "description": "The same counts per setting. Settings without this language are left out.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" - }, - "type": "array", - "uniqueItems": true + "LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" + } + }, + "type": "object" + }, + "LocalizationSourceCounts": { + "description": "Counts per source. Sources without any count are left out. In the organization, users without their own setting have no source and are only in the total.", + "properties": { + "DEFAULT": { + "format": "int32", + "type": "integer" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "ENVIRONMENT": { + "format": "int32", + "type": "integer" + }, + "ORGANIZATION": { + "format": "int32", + "type": "integer" + }, + "PARENT": { + "format": "int32", + "type": "integer" + }, + "USER": { + "format": "int32", + "type": "integer" + }, + "WORKSPACE": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocalizationStatistics": { + "properties": { + "data": { + "$ref": "#/components/schemas/LocalizationDataStatistics" + }, + "metadata": { + "$ref": "#/components/schemas/LocalizationMetadataStatistics" } }, "required": [ - "data" + "data", + "metadata" ], "type": "object" }, - "JsonApiVisualizationObjectOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "LocalizationStatisticsLocale": { + "properties": { + "locale": { + "description": "Language tag.", + "example": "de-DE", + "type": "string" } - ] + }, + "required": [ + "locale" + ], + "type": "object" }, - "JsonApiVisualizationObjectPatch": { - "description": "JSON:API representation of patching visualizationObject entity.", + "LocalizationUsage": { "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, - "properties": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" - }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" - }, - "type": "array" - } - }, - "required": [ - "enabled", - "rules" - ], - "type": "object" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } + "defaults": { + "$ref": "#/components/schemas/LocalizationDefaults" + }, + "values": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageValue" }, - "type": "object" + "type": "array" + } + }, + "required": [ + "defaults", + "values" + ], + "type": "object" + }, + "LocalizationUsageUser": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationUserValues" + }, + "email": { + "nullable": true, + "type": "string" }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", + "name": { + "description": "First and last name. Null when the user has neither.", + "nullable": true, + "type": "string" + }, + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "visualizationObject" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], - "example": "visualizationObject", "type": "string" } }, "required": [ - "attributes", + "bySetting", "id", - "type" + "source" ], "type": "object" }, - "JsonApiVisualizationObjectPatchDocument": { + "LocalizationUsageUsers": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + "totalCount": { + "description": "The total number of users that match the filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageUser" + }, + "type": "array" } }, "required": [ - "data" + "totalCount", + "users" ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalId": { - "description": "JSON:API representation of visualizationObject entity.", + "LocalizationUsageValue": { + "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting.", "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, - "properties": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" - }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" - }, - "type": "array" - } - }, - "required": [ - "enabled", - "rules" - ], - "type": "object" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" + "bySetting": { + "$ref": "#/components/schemas/LocalizationSettingUsages" + }, + "content": { + "$ref": "#/components/schemas/LocalizationContent" + }, + "users": { + "$ref": "#/components/schemas/LocalizationCount" + }, + "workspaces": { + "$ref": "#/components/schemas/LocalizationCount" + } + }, + "required": [ + "bySetting", + "content", + "users", + "workspaces" + ], + "type": "object" + }, + "LocalizationUsageWorkspace": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "childrenCount": { + "description": "Number of direct child workspaces.", + "format": "int32", + "type": "integer" }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", + "name": { + "type": "string" + }, + "parentId": { + "description": "The parent workspace, or null for a root workspace.", + "nullable": true, + "type": "string" + }, + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "visualizationObject" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], - "example": "visualizationObject", "type": "string" } }, "required": [ - "attributes", - "type" + "bySetting", + "childrenCount", + "id", + "name", + "source" ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalIdDocument": { + "LocalizationUsageWorkspaces": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + "totalCount": { + "description": "The total number of workspaces that match the filters.", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageWorkspace" + }, + "type": "array" } }, "required": [ - "data" + "totalCount", + "workspaces" ], "type": "object" }, - "JsonApiVisualizationObjectToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" - }, - "type": "array" - }, - "JsonApiVisualizationObjectToOneLinkage": { - "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.", + "LocalizationUserValue": { + "description": "The value a user gets for one setting, and where it comes from. In the organization users list, it is the value the user sets, with source USER. It is null when the user does not set the setting, because the value then depends on the workspace. In the workspace users list, it is never null. It is the value the user sets, with source USER. Otherwise it is the value the workspace gets, with the source of the workspace. For the origin of that value, see `originId` in the workspace usage. `content.value` is null when the user gets no language.", "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" + "properties": { + "content": { + "$ref": "#/components/schemas/LocalizationContent" + }, + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" } - ] + }, + "required": [ + "content", + "source" + ], + "type": "object" }, - "JsonApiWorkspaceAutomationOut": { - "description": "JSON:API representation of workspaceAutomation entity.", + "LocalizationUserValues": { + "description": "The value the user gets for each setting.", "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" - }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" - }, - "interval": { - "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", - "enum": [ - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", - "enum": [ - "ALWAYS", - "ONCE", - "ONCE_PER_INTERVAL" - ], - "type": "string" - } - }, - "required": [ - "condition", - "execution" - ], - "type": "object" - }, - "areRelationsValid": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" - } - }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" - }, - "type": "array" - }, - "widget": { - "type": "string" - } - }, - "type": "object" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" - }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" - }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" - }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - } - }, - "type": "object" + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" }, - "relationships": { + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" + } + }, + "type": "object" + }, + "MatchAttributeFilter": { + "description": "Filter via label with given match type and literal value.", + "properties": { + "matchAttributeFilter": { "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "automationResults": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "applyOnResult": { + "type": "boolean" }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "caseSensitive": { + "default": false, + "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", + "type": "boolean" }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "label": { + "$ref": "#/components/schemas/AfmIdentifier" }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "literal": { + "description": "Literal used to limit label values.", + "example": "value", + "type": "string" }, - "workspace": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" + "localIdentifier": { + "type": "string" + }, + "matchType": { + "description": "Requested match type.", + "enum": [ + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" ], - "type": "object" + "type": "string" + }, + "negate": { + "default": false, + "description": "Indicates whether the filter should negate the match.", + "type": "boolean" } }, + "required": [ + "label", + "literal", + "matchType" + ], "type": "object" + } + }, + "required": [ + "matchAttributeFilter" + ], + "type": "object" + }, + "MatomoService": { + "description": "Matomo service.", + "properties": { + "host": { + "description": "Telemetry host to send events to.", + "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceAutomation" - ], - "example": "workspaceAutomation", + "reportingEndpoint": { + "description": "Optional reporting endpoint for proxying telemetry events.", "type": "string" + }, + "siteId": { + "description": "Site ID on telemetry server.", + "format": "int32", + "type": "integer" } }, "required": [ - "id", - "type" + "host", + "siteId" ], "type": "object" }, - "JsonApiWorkspaceAutomationOutIncludes": { + "MeasureDefinition": { + "description": "Abstract metric definition type", "oneOf": [ { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + "$ref": "#/components/schemas/InlineMeasureDefinition" }, { - "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" + "$ref": "#/components/schemas/ArithmeticMeasureDefinition" }, { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + "$ref": "#/components/schemas/SimpleMeasureDefinition" }, { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + "$ref": "#/components/schemas/PopMeasureDefinition" + } + ], + "type": "object" + }, + "MeasureExecutionResultHeader": { + "properties": { + "measureHeader": { + "$ref": "#/components/schemas/MeasureResultHeader" + } + }, + "required": [ + "measureHeader" + ], + "type": "object" + }, + "MeasureGroupHeaders": { + "description": "Measure group headers", + "properties": { + "measureGroupHeaders": { + "items": { + "$ref": "#/components/schemas/MeasureHeader" + }, + "type": "array" + } + }, + "type": "object" + }, + "MeasureHeader": { + "properties": { + "format": { + "description": "Format to be used to format the measure data.", + "type": "string" + }, + "localIdentifier": { + "description": "Local identifier of the measure this header relates to.", + "type": "string" + }, + "name": { + "description": "Name of the measure.", + "type": "string" + } + }, + "required": [ + "localIdentifier" + ], + "type": "object" + }, + "MeasureItem": { + "description": "Metric is a quantity that is calculated from the data.", + "properties": { + "definition": { + "$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.", + "example": "metric_1", + "pattern": "^[.a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "required": [ + "definition", + "localIdentifier" + ], + "type": "object" + }, + "MeasureResultHeader": { + "description": "Header containing the information related to metrics.", + "properties": { + "measureIndex": { + "description": "Metric index. Starts at 0.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "measureIndex" + ], + "type": "object" + }, + "MeasureValueCondition": { + "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonCondition" }, { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "$ref": "#/components/schemas/RangeCondition" + } + ], + "type": "object" + }, + "MeasureValueFilter": { + "description": "Abstract filter definition type filtering by the value of the metric.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/CompoundMeasureValueFilter" } - ] + ], + "type": "object" }, - "JsonApiWorkspaceAutomationOutList": { - "description": "A JSON:API document with a list of resources", + "MemoryItemCreatedByUsers": { "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "reasoning": { + "description": "Reasoning for error states", + "type": "string" }, - "included": { - "description": "Included resources", + "users": { + "description": "Users who created memory item", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + "$ref": "#/components/schemas/MemoryItemUser" }, - "type": "array", - "uniqueItems": true + "type": "array" + } + }, + "required": [ + "reasoning", + "users" + ], + "type": "object" + }, + "MemoryItemUser": { + "description": "Users who created memory item", + "properties": { + "firstname": { + "description": "First name of the user who created memory item", + "type": "string" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "lastname": { + "description": "Last name of the user who created memory item", + "type": "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "userId": { + "description": "User ID of the user who created memory item", + "type": "string" } }, "required": [ - "data" + "firstname", + "lastname", + "userId" ], "type": "object" }, - "JsonApiWorkspaceAutomationOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" } - ] + }, + "required": [ + "definition", + "item" + ], + "type": "object" }, - "JsonApiWorkspaceColorPaletteIn": { - "description": "JSON:API representation of workspaceColorPalette entity.", + "MetricPermissions": { "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" }, - "required": [ - "content", - "name" - ], - "type": "object" + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceColorPalette" - ], - "example": "workspaceColorPalette", - "type": "string" + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" } }, "required": [ - "attributes", - "id", - "type" + "rules", + "userGroups", + "users" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteInDocument": { + "MetricPermissionsAssignment": { + "description": "Desired levels of permissions on a metric for an assignee.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "permissions" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOut": { - "description": "JSON:API representation of workspaceColorPalette entity.", - "properties": { - "attributes": { + "MetricPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, - "required": [ - "content", - "name" - ], "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" }, - "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" + "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": { + "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceColorPalette" - ], - "example": "workspaceColorPalette", + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "MetricValueChange": { + "description": "Individual change analysis data item", + "properties": { + "attributeName": { + "deprecated": true, + "description": "Deprecated: bare id of the analyzed label or computed attribute, without its type. Use attributeRef instead.", + "type": "string" + }, + "attributeRef": { + "$ref": "#/components/schemas/AfmObjectIdentifierLabel" + }, + "attributeValue": { + "description": "The value of the attribute being analyzed", "type": "string" + }, + "attributeValuesChangeMean": { + "description": "The mean of attribute value changes for the attribute being analyzed", + "format": "double", + "type": "number" + }, + "attributeValuesChangeStd": { + "description": "The standard deviation of attribute value changes for the attribute being analyzed", + "format": "double", + "type": "number" + }, + "isSignificantChange": { + "description": "Whether the change is statistically significant", + "type": "boolean" + }, + "metricValueDelta": { + "description": "The delta between analyzed and reference periods", + "format": "double", + "type": "number" + }, + "metricValueDeltaAbs": { + "description": "The absolute delta between analyzed and reference periods", + "format": "double", + "type": "number" + }, + "metricValueInAnalyzedPeriod": { + "description": "The metric value in the analyzed period", + "format": "double", + "type": "number" + }, + "metricValueInReferencePeriod": { + "description": "The metric value in the reference period", + "format": "double", + "type": "number" + }, + "overallMetricValueInAnalyzedPeriod": { + "description": "The overall metric value in the analyzed period", + "format": "double", + "type": "number" + }, + "overallMetricValueInReferencePeriod": { + "description": "The overall metric value in the reference period", + "format": "double", + "type": "number" } }, "required": [ - "attributes", - "id", - "type" + "attributeName", + "attributeRef", + "attributeValue", + "attributeValuesChangeMean", + "attributeValuesChangeStd", + "isSignificantChange", + "metricValueDelta", + "metricValueDeltaAbs", + "metricValueInAnalyzedPeriod", + "metricValueInReferencePeriod", + "overallMetricValueInAnalyzedPeriod", + "overallMetricValueInReferencePeriod" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutDocument": { + "ModelTestResult": { + "description": "Per-model test results.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "message": { + "description": "Message about the model test result.", + "type": "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "modelId": { + "description": "The model ID that was tested.", + "type": "string" + }, + "successful": { + "description": "Whether the model test was successful.", + "type": "boolean" } }, "required": [ - "data" + "message", + "modelId", + "successful" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutList": { - "description": "A JSON:API document with a list of resources", + "NegativeAttributeFilter": { + "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { + "negativeAttributeFilter": { "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "applyOnResult": { + "type": "boolean" + }, + "label": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "localIdentifier": { + "type": "string" + }, + "notIn": { + "$ref": "#/components/schemas/AttributeFilterElements" + }, + "usesArbitraryValues": { + "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", + "type": "boolean" } }, + "required": [ + "label", + "notIn" + ], "type": "object" } }, "required": [ - "data" + "negativeAttributeFilter" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceColorPalettePatch": { - "description": "JSON:API representation of patching workspaceColorPalette entity.", + "Note": { "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", + "appliesTo": { "enum": [ - "workspaceColorPalette" + "SOURCE", + "TARGET" ], - "example": "workspaceColorPalette", + "type": "string", + "xml": { + "attribute": true + } + }, + "category": { + "type": "string", + "xml": { + "attribute": true + } + }, + "content": { "type": "string" + }, + "id": { + "type": "string", + "xml": { + "attribute": true + } + }, + "otherAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "priority": { + "format": "int32", + "type": "integer", + "xml": { + "attribute": true + } } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, - "JsonApiWorkspaceColorPalettePatchDocument": { + "Notes": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" + "note": { + "items": { + "$ref": "#/components/schemas/Note" + }, + "type": "array" } }, "required": [ - "data" + "note" ], - "type": "object" + "type": "object", + "xml": { + "name": "notes", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, - "JsonApiWorkspaceDataFilterIn": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "Notification": { "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" + "automationId": { + "type": "string" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "data": { + "oneOf": [ + { + "$ref": "#/components/schemas/AutomationNotification" }, - "title": { - "maxLength": 255, - "type": "string" + { + "$ref": "#/components/schemas/TestNotification" } - }, - "type": "object" + ] }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "isRead": { + "type": "boolean" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", + "workspaceId": { "type": "string" } }, "required": [ + "createdAt", + "data", "id", - "type" + "isRead" ], "type": "object" }, - "JsonApiWorkspaceDataFilterInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + "NotificationChannelDestination": { + "oneOf": [ + { + "$ref": "#/components/schemas/Webhook" + }, + { + "$ref": "#/components/schemas/Smtp" + }, + { + "$ref": "#/components/schemas/DefaultSmtp" + }, + { + "$ref": "#/components/schemas/InPlatform" } - }, - "required": [ - "data" ], "type": "object" }, - "JsonApiWorkspaceDataFilterLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" + "NotificationContent": { + "discriminator": { + "mapping": { + "AUTOMATION": "#/components/schemas/AutomationNotification", + "TEST": "#/components/schemas/TestNotification" }, + "propertyName": "type" + }, + "properties": { "type": { - "enum": [ - "workspaceDataFilter" - ], "type": "string" } }, "required": [ - "id", "type" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOut": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "NotificationFilter": { "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "filter": { "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" - }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", + "title": { "type": "string" } }, "required": [ - "id", - "type" + "filter", + "title" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutDocument": { + "NotificationParameter": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "id": { + "type": "string" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "title": { + "type": "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "value": { + "type": "string" }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "valueTitle": { + "type": "string" } }, "required": [ - "data" + "id", + "value" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutList": { - "description": "A JSON:API document with a list of resources", + "Notifications": { "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "$ref": "#/components/schemas/Notification" }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "type": "array" }, "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "$ref": "#/components/schemas/NotificationsMeta" } }, "required": [ - "data" + "data", + "meta" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceDataFilterPatch": { - "description": "JSON:API representation of patching workspaceDataFilter entity.", + "NotificationsMeta": { "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 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": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" + "total": { + "$ref": "#/components/schemas/NotificationsMetaTotal" } }, - "required": [ - "id", - "type" - ], "type": "object" }, - "JsonApiWorkspaceDataFilterPatchDocument": { + "NotificationsMetaTotal": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + "all": { + "format": "int64", + "type": "integer" + }, + "unread": { + "format": "int64", + "type": "integer" } }, "required": [ - "data" + "all", + "unread" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingIn": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "NumberConstraints": { "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "max": { + "format": "double", + "type": "number" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "min": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "NumberParameterDefinition": { + "properties": { + "constraints": { + "$ref": "#/components/schemas/NumberConstraints" + }, + "defaultValue": { + "format": "double", + "type": "number" }, "type": { - "description": "Object type", + "description": "The parameter type.", "enum": [ - "workspaceDataFilterSetting" + "NUMBER" ], - "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ - "id", + "defaultValue", "type" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingInDocument": { + "ObjectConditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this object.", + "nullable": true, "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" + }, + "enabled": { + "description": "Whether the conditions are applied when rendering.", + "type": "boolean" } }, "required": [ - "data" + "conditions", + "enabled" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "ObjectLinks": { "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "workspaceDataFilterSetting" - ], + "self": { + "description": "A string containing the link's URL.", + "format": "uri", "type": "string" } }, "required": [ - "id", - "type" + "self" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOut": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "ObjectLinksContainer": { "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "type": "object" + }, + "ObjectStorageInfo": { + "description": "Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.", + "properties": { + "name": { + "description": "Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds.", + "example": "s3-data-lake", "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" - } + "storageConfig": { + "additionalProperties": { + "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", + "type": "string" }, + "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", "type": "object" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "storageId": { + "description": "Stable identifier of the storage configuration (UUID).", + "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", + "storageType": { + "description": "Provider type.", + "example": "s3", "type": "string" } }, "required": [ - "id", - "type" + "name", + "storageConfig", + "storageId", + "storageType" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutDocument": { + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "baseUrl": { + "default": "https://api.openai.com/v1", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, + "type": "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, + "type": "string" }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "type": { + "description": "Provider type.", + "enum": [ + "OPENAI" + ], + "type": "string" } }, "required": [ - "data" + "auth", + "type" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { + "OpenAiApiKeyAuth": { + "allOf": [ + { "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "apiKey": { + "description": "OpenAI API key.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true + "type": { + "description": "Authentication type.", + "enum": [ + "API_KEY" + ], + "type": "string" } }, "type": "object" } - }, + ], "required": [ - "data" + "type" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" - }, + "OpenAiProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ { - "$ref": "#/components/schemas/ObjectLinksContainer" + "$ref": "#/components/schemas/OpenAiApiKeyAuth" } - ] + ], + "type": "object" }, - "JsonApiWorkspaceDataFilterSettingPatch": { - "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", + "OpenTelemetryService": { + "description": "OpenTelemetry service.", "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" + "host": { + "description": "Telemetry host to send events to.", + "type": "string" + } + }, + "required": [ + "host" + ], + "type": "object" + }, + "Operation": { + "description": "Represents a Long-Running Operation: a process that takes some time to complete.", + "discriminator": { + "mapping": { + "failed": "#/components/schemas/FailedOperation", + "pending": "#/components/schemas/PendingOperation", + "succeeded": "#/components/schemas/SucceededOperation" }, + "propertyName": "status" + }, + "properties": { "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "description": "Id of the operation", "type": "string" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", + "kind": { + "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n", "enum": [ - "workspaceDataFilterSetting" + "provision-database", + "deprovision-database", + "run-service-command", + "analyze-statistics" ], - "example": "workspaceDataFilterSetting", + "type": "string" + }, + "status": { "type": "string" } }, "required": [ "id", - "type" + "kind", + "status" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingPatchDocument": { + "OperationError": { + "description": "Error information for a failed operation", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" + "detail": { + "description": "Human-readable error details", + "type": "string" + }, + "status": { + "description": "HTTP status code", + "format": "int32", + "type": "integer" + }, + "title": { + "description": "Human-readable error name", + "type": "string" } }, "required": [ - "data" + "detail", + "status", + "title" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" - }, - "type": "array" - }, - "JsonApiWorkspaceDataFilterToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + "OrganizationAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + }, + "workspaceId": { + "type": "string" + } }, - "type": "array" + "required": [ + "id", + "workspaceId" + ], + "type": "object" }, - "JsonApiWorkspaceDataFilterToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + "OrganizationAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type": "array" } - ] + }, + "required": [ + "automations" + ], + "type": "object" }, - "JsonApiWorkspaceExportTemplateIn": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "OrganizationCacheSettings": { + "description": "Settings for organization cache.", "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" - } + "extraCacheBudget": { + "description": "Extra cache budget the organization can allocate among its workspaces, in bytes.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "extraCacheBudget" + ], + "type": "object" + }, + "OrganizationCacheUsage": { + "description": "Data about the whole organization's cache usage.", + "properties": { + "current": { + "$ref": "#/components/schemas/OrganizationCurrentCacheUsage" + }, + "removalIntervals": { + "description": "List of cache removal intervals.", + "items": { + "$ref": "#/components/schemas/CacheRemovalInterval" }, - "required": [ - "name" - ], - "type": "object" + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "settings": { + "$ref": "#/components/schemas/OrganizationCacheSettings" + } + }, + "required": [ + "current", + "removalIntervals", + "settings" + ], + "type": "object" + }, + "OrganizationCurrentCacheUsage": { + "description": "Current cache usage of the organization.", + "properties": { + "cacheUsed": { + "description": "Cache currently used by the organization, in bytes.", + "format": "int64", + "type": "integer" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceExportTemplate" - ], - "example": "workspaceExportTemplate", + "removalPeriodStart": { + "description": "Start timestamp of removal period.", + "format": "date-time", "type": "string" + }, + "removedSinceStart": { + "description": "Bytes removed since start due to insufficient cache.", + "format": "int64", + "type": "integer" } }, "required": [ - "attributes", - "id", - "type" + "cacheUsed", + "removedSinceStart" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateInDocument": { + "OrganizationPermissionAssignment": { + "description": "Organization permission assignments", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "permissions": { + "items": { + "enum": [ + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOut": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "OutlierDetectionRequest": { "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" - } + "description": "Attributes to be used in the computation.", + "items": { + "$ref": "#/components/schemas/AttributeItem" }, - "required": [ - "name" - ], - "type": "object" + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "auxMeasures": { + "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items": { + "$ref": "#/components/schemas/MeasureItem" + }, + "type": "array" + }, + "filters": { + "description": "Various filter types to filter the execution result.", + "items": { + "$ref": "#/components/schemas/FilterDefinition" + }, + "type": "array" + }, + "granularity": { + "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", + "enum": [ + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], "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" - } + "measures": { + "items": { + "$ref": "#/components/schemas/MeasureItem" }, - "type": "object" + "minItems": 1, + "type": "array" }, - "type": { - "description": "Object type", + "sensitivity": { + "description": "Sensitivity level for outlier detection", "enum": [ - "workspaceExportTemplate" + "LOW", + "MEDIUM", + "HIGH" ], - "example": "workspaceExportTemplate", "type": "string" } }, "required": [ "attributes", - "id", - "type" + "granularity", + "measures", + "sensitivity" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutDocument": { + "OutlierDetectionResponse": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" - }, "links": { - "$ref": "#/components/schemas/ObjectLinks" + "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ - "data" + "links" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutList": { - "description": "A JSON:API document with a list of resources", + "OutlierDetectionResult": { "properties": { - "data": { + "attribute": { + "description": "Attribute values for outlier detection results.", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + "type": "string" }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "nullable": true, + "type": "array" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } + "values": { + "additionalProperties": { + "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "items": { + "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "nullable": true, + "type": "number" + }, + "nullable": true, + "type": "array" }, + "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "nullable": true, "type": "object" } }, "required": [ - "data" + "attribute", + "values" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceExportTemplatePatch": { - "description": "JSON:API representation of patching workspaceExportTemplate entity.", + "Over": { "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" - } + "items": { + "$ref": "#/components/schemas/IdentifierRef" }, - "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" + "type": "array" } }, "required": [ - "attributes", - "id", - "type" + "attributes" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePatchDocument": { + "PageMetadata": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + "number": { + "description": "The number of the current page", + "format": "int32", + "type": "integer" + }, + "size": { + "description": "The size of the current page", + "format": "int32", + "type": "integer" + }, + "totalElements": { + "description": "The total number of elements", + "format": "int32", + "type": "integer" + }, + "totalPages": { + "description": "The total number of pages", + "format": "int32", + "type": "integer" } }, - "required": [ - "data" - ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalId": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "Paging": { + "description": "Current page description.", "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" + "count": { + "description": "Count of items in this page.", + "example": 5, + "format": "int32", + "type": "integer" + }, + "next": { + "description": "Link to next page, or null if this is last page.", + "example": "https://sample.gooddata.ai/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10", + "type": "string" + }, + "offset": { + "description": "Offset of this page.", + "example": 10, + "format": "int32", + "type": "integer" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "total": { + "description": "Count of returnable items ignoring paging.", + "example": 100, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "count", + "offset", + "total" + ], + "type": "object" + }, + "Parameter": { + "properties": { + "name": { "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceExportTemplate" - ], - "example": "workspaceExportTemplate", + "value": { "type": "string" } }, "required": [ - "attributes", - "type" + "name", + "value" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { + "ParameterDefinition": { + "description": "Parameter content (type-discriminated).", + "discriminator": { + "mapping": { + "NUMBER": "#/components/schemas/NumberParameterDefinition", + "STRING": "#/components/schemas/StringParameterDefinition" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/NumberParameterDefinition" + }, + { + "$ref": "#/components/schemas/StringParameterDefinition" + } + ], + "type": "object" + }, + "ParameterItem": { + "additionalProperties": true, + "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + }, + "value": { + "description": "Value to use for this parameter instead of its default.", + "type": "string" } }, "required": [ - "data" + "parameter", + "value" ], "type": "object" }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", + "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": { - "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}$", + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", "type": "string" }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "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" + }, + "valueTitle": { + "description": "Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.", + "example": "year 2026", + "type": "string" + } + }, + "required": [ + "id", + "title", + "value" + ], + "type": "object" + }, + "PdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", + "example": [ + { + "properties": [ + { + "key": "font-size", + "value": "30px" } + ], + "selector": "th" + } + ], + "properties": { + "properties": { + "description": "List of CSS properties.", + "items": { + "$ref": "#/components/schemas/PdfTableStyleProperty" }, - "type": "object" + "type": "array" }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", + "selector": { + "description": "CSS selector where to apply given properties.", "type": "string" } }, "required": [ - "id", - "type" + "selector" ], "type": "object" }, - "JsonApiWorkspaceInDocument": { + "PdfTableStyleProperty": { + "description": "CSS property.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" + "key": { + "description": "CSS property key.", + "type": "string" + }, + "value": { + "description": "CSS property value.", + "type": "string" } }, "required": [ - "data" + "key", + "value" ], "type": "object" }, - "JsonApiWorkspaceLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "PdmLdmRequest": { + "description": "PDM additions wrapper.", "properties": { - "id": { + "sqls": { + "description": "List of SQL datasets.", + "items": { + "$ref": "#/components/schemas/PdmSql" + }, + "type": "array" + }, + "tableOverrides": { + "description": "(BETA) List of table overrides.", + "items": { + "$ref": "#/components/schemas/TableOverride" + }, + "type": "array" + }, + "tables": { + "description": "List of physical database tables.", + "items": { + "$ref": "#/components/schemas/DeclarativeTable" + }, + "type": "array" + } + }, + "type": "object" + }, + "PdmSql": { + "description": "SQL dataset definition.", + "properties": { + "columns": { + "description": "Columns defining SQL dataset.", + "items": { + "$ref": "#/components/schemas/SqlColumn" + }, + "type": "array" + }, + "statement": { + "description": "SQL statement.", + "example": "select * from abc", "type": "string" }, - "type": { + "title": { + "description": "SQL dataset title.", + "example": "My special dataset", + "type": "string" + } + }, + "required": [ + "statement", + "title" + ], + "type": "object" + }, + "PendingOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/Operation" + } + ], + "description": "Operation that is still pending", + "properties": { + "status": { "enum": [ - "workspace" + "pending" ], "type": "string" } }, "required": [ "id", - "type" + "kind", + "status" ], "type": "object" }, - "JsonApiWorkspaceOut": { - "description": "JSON:API representation of workspace entity.", + "PermissionsAssignment": { "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" - }, - "managed": { - "description": "Whether the object is platform-managed and read-only.", - "type": "boolean" - }, - "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" - } + "assignees": { + "items": { + "$ref": "#/components/schemas/AssigneeIdentifier" }, - "type": "object" + "minItems": 1, + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" }, - "meta": { + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "assignees" + ], + "type": "object" + }, + "PermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" + }, + { "properties": { - "config": { - "properties": { - "approximateCountAvailable": { - "default": false, - "description": "is approximate count enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "dataSamplingAvailable": { - "default": false, - "description": "is sampling enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "showAllValuesOnDatesAvailable": { - "default": false, - "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", - "type": "boolean" - } - }, - "type": "object" - }, - "dataModel": { - "properties": { - "datasetCount": { - "description": "include the number of dataset of each workspace", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "datasetCount" - ], - "type": "object" - }, - "hierarchy": { - "properties": { - "childrenCount": { - "description": "include the number of direct children of each workspace", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "childrenCount" - ], - "type": "object" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "WRITE_KNOWLEDGE_DOCUMENTS", - "READ_KNOWLEDGE_DOCUMENTS", - "CREATE_FILTER_VIEW", - "CREATE_METRIC", - "MANAGE_VISUALIZATIONS", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" - }, - "type": "array" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" + } + ], + "description": "Desired levels of permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "PermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, - "relationships": { + { "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" } }, "type": "object" + } + ], + "description": "Desired levels of permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "PlatformUsage": { + "properties": { + "count": { + "format": "int32", + "type": "integer" }, - "type": { - "description": "Object type", + "name": { "enum": [ - "workspace" + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" ], - "example": "workspace", "type": "string" } }, "required": [ - "id", - "type" + "name" ], "type": "object" }, - "JsonApiWorkspaceOutDocument": { + "PlatformUsageRequest": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" - }, - "included": { - "description": "Included resources", + "usageItemNames": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "enum": [ + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" + ], + "type": "string" }, "type": "array", "uniqueItems": true + } + }, + "required": [ + "usageItemNames" + ], + "type": "object" + }, + "PopDataset": { + "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties": { + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - }, - "meta": { + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "dataset", + "periodsAgo" + ], + "type": "object" + }, + "PopDatasetMeasureDefinition": { + "description": "Previous period type of metric.", + "properties": { + "previousPeriodMeasure": { "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "dateDatasets": { + "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", "items": { - "$ref": "#/components/schemas/RestrictedObject" + "$ref": "#/components/schemas/PopDataset" }, - "type": "array", - "uniqueItems": true + "type": "array" + }, + "measureIdentifier": { + "$ref": "#/components/schemas/AfmLocalIdentifier" } }, + "required": [ + "dateDatasets", + "measureIdentifier" + ], "type": "object" } }, "required": [ - "data" + "previousPeriodMeasure" ], "type": "object" }, - "JsonApiWorkspaceOutList": { - "description": "A JSON:API document with a list of resources", + "PopDate": { + "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "attribute": { + "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, - "meta": { + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "attribute", + "periodsAgo" + ], + "type": "object" + }, + "PopDateMeasureDefinition": { + "description": "Period over period type of metric.", + "properties": { + "overPeriodMeasure": { "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "dateAttributes": { + "description": "Attributes to use for determining the period to calculate the PoP for.", "items": { - "$ref": "#/components/schemas/RestrictedObject" + "$ref": "#/components/schemas/PopDate" }, - "type": "array", - "uniqueItems": true + "type": "array" + }, + "measureIdentifier": { + "$ref": "#/components/schemas/AfmLocalIdentifier" } }, + "required": [ + "dateAttributes", + "measureIdentifier" + ], "type": "object" } }, "required": [ - "data" + "overPeriodMeasure" ], "type": "object" }, - "JsonApiWorkspaceOutWithLinks": { - "allOf": [ + "PopMeasureDefinition": { + "oneOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/PopDatasetMeasureDefinition" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" + "$ref": "#/components/schemas/PopDateMeasureDefinition" } - ] + ], + "type": "object" }, - "JsonApiWorkspacePatch": { - "description": "JSON:API representation of patching workspace entity.", + "PositiveAttributeFilter": { + "description": "Filter able to limit element values by label and related selected elements.", "properties": { - "attributes": { + "positiveAttributeFilter": { "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" + "applyOnResult": { + "type": "boolean" }, - "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" + "in": { + "$ref": "#/components/schemas/AttributeFilterElements" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" + "label": { + "$ref": "#/components/schemas/AfmIdentifier" }, - "name": { - "maxLength": 255, - "nullable": true, + "localIdentifier": { "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" + "usesArbitraryValues": { + "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", + "type": "boolean" } }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspace" + "required": [ + "in", + "label" ], - "example": "workspace", - "type": "string" + "type": "object" } }, "required": [ - "id", - "type" + "positiveAttributeFilter" ], "type": "object" }, - "JsonApiWorkspacePatchDocument": { + "Profile": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspacePatch" + "entitlements": { + "description": "Defines entitlements for given organization.", + "items": { + "$ref": "#/components/schemas/ApiEntitlement" + }, + "type": "array" + }, + "features": { + "oneOf": [ + { + "$ref": "#/components/schemas/LiveFeatures" + }, + { + "$ref": "#/components/schemas/StaticFeatures" + } + ] + }, + "links": { + "$ref": "#/components/schemas/ProfileLinks" + }, + "name": { + "type": "string" + }, + "organizationId": { + "type": "string" + }, + "organizationName": { + "type": "string" + }, + "permissions": { + "items": { + "enum": [ + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" + ], + "type": "string" + }, + "type": "array" + }, + "telemetryConfig": { + "$ref": "#/components/schemas/TelemetryConfig" + }, + "userId": { + "type": "string" } }, "required": [ - "data" + "entitlements", + "features", + "links", + "organizationId", + "organizationName", + "permissions", + "telemetryConfig", + "userId" ], "type": "object" }, - "JsonApiWorkspaceSettingIn": { - "description": "JSON:API representation of workspaceSetting entity.", + "ProfileLinks": { "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" - } - }, - "type": "object" + "organization": { + "type": "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "self": { "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", + "user": { "type": "string" } }, "required": [ - "id", - "type" + "organization", + "self", + "user" ], "type": "object" }, - "JsonApiWorkspaceSettingInDocument": { + "ProvisionDatabaseInstanceRequest": { + "description": "Request to provision a new AILake Database instance", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" + "dataSourceId": { + "description": "Identifier for the data source created in metadata-api. Defaults to the database name.", + "type": "string" + }, + "dataSourceName": { + "description": "Display name for the data source created in metadata-api. Defaults to the database name.", + "type": "string" + }, + "name": { + "description": "Name of the database instance", + "type": "string" + }, + "storageIds": { + "description": "Set of ids of the storage instances this database instance should access.", + "items": { + "description": "Set of ids of the storage instances this database instance should access.", + "type": "string" + }, + "type": "array", + "uniqueItems": true } }, "required": [ - "data" + "name", + "storageIds" ], "type": "object" }, - "JsonApiWorkspaceSettingOut": { - "description": "JSON:API representation of workspaceSetting entity.", + "PublisherDocumentArbitraryAttributeFilter": { + "description": "Filters an attribute display form by arbitrary values.", "properties": { - "attributes": { + "arbitraryAttributeFilter": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], + "filterElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParent" + }, + "type": "array" + }, + "filterElementsByDate": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterByDate" + }, + "type": "array" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "title": { "type": "string" + }, + "validateElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" + }, + "values": { + "description": "Values; `null` stands for an empty value.", + "items": { + "type": "string" + }, + "type": "array" } }, + "required": [ + "displayForm", + "negativeSelection", + "values" + ], "type": "object" + } + }, + "required": [ + "arbitraryAttributeFilter" + ], + "type": "object" + }, + "PublisherDocumentAreaStyle": { + "description": "Style of the area behind the pages. Lengths are in canvas px.", + "properties": { + "backgroundColor": { + "type": "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], "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" + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" }, - "type": { - "description": "Object type", + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { "enum": [ - "workspaceSetting" + "top", + "center", + "bottom" ], - "example": "workspaceSetting", "type": "string" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] } }, - "required": [ - "id", - "type" + "type": "object" + }, + "PublisherDocumentAttributeElements": { + "description": "Selected attribute elements: `{\"values\": [...]}` or `{\"uris\": [...]}`.", + "oneOf": [ + { + "$ref": "#/components/schemas/PublisherDocumentAttributeElementsByValue" + }, + { + "$ref": "#/components/schemas/PublisherDocumentAttributeElementsByUri" + } ], "type": "object" }, - "JsonApiWorkspaceSettingOutDocument": { + "PublisherDocumentAttributeElementsByUri": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "uris": { + "description": "Element URIs; `null` stands for an empty value.", + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "uris" ], "type": "object" }, - "JsonApiWorkspaceSettingOutList": { - "description": "A JSON:API document with a list of resources", + "PublisherDocumentAttributeElementsByValue": { "properties": { - "data": { + "values": { + "description": "Element values; `null` stands for an empty value.", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } + "type": "string" }, - "type": "object" + "type": "array" } }, "required": [ - "data" + "values" ], "type": "object" }, - "JsonApiWorkspaceSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceSettingPatch": { - "description": "JSON:API representation of patching workspaceSetting entity.", + "PublisherDocumentAttributeFilter": { + "description": "Filters an attribute display form by a list of elements.", "properties": { - "attributes": { + "attributeFilter": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "attributeElements": { + "$ref": "#/components/schemas/PublisherDocumentAttributeElements" }, - "type": { + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "filterElementsBy": { + "description": "Parent filters that limit the offered elements.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParent" + }, + "type": "array" + }, + "filterElementsByDate": { + "description": "Date filters that limit the offered elements.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterByDate" + }, + "type": "array" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "selectionMode": { "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + "single", + "multi" ], "type": "string" + }, + "title": { + "type": "string" + }, + "validateElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" } }, - "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": [ - "workspaceSetting" + "required": [ + "attributeElements", + "displayForm", + "negativeSelection" ], - "example": "workspaceSetting", - "type": "string" + "type": "object" } }, "required": [ - "id", - "type" + "attributeFilter" ], "type": "object" }, - "JsonApiWorkspaceSettingPatchDocument": { + "PublisherDocumentAttributeFilterByDate": { + "description": "A date filter that limits the offered elements.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "filterLocalIdentifier": { + "type": "string" + }, + "isCommonDate": { + "type": "boolean" } }, "required": [ - "data" + "filterLocalIdentifier", + "isCommonDate" ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalId": { - "description": "JSON:API representation of workspaceSetting entity.", + "PublisherDocumentAttributeFilterConfig": { + "description": "How a document attribute filter is shown, as in dashboards.", "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" - } - }, - "type": "object" + "displayAsLabel": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "localIdentifier": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "type": { - "description": "Object type", + "mode": { "enum": [ - "workspaceSetting" + "readonly", + "hidden", + "active" + ], + "type": "string" + }, + "selectionType": { + "enum": [ + "list", + "text", + "listOrText" ], - "example": "workspaceSetting", "type": "string" } }, "required": [ - "type" + "localIdentifier" ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalIdDocument": { + "PublisherDocumentAttributeFilterParent": { + "description": "A parent attribute filter that limits the offered elements.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" + "filterLocalIdentifier": { + "type": "string" + }, + "over": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParentOver" } }, "required": [ - "data" + "filterLocalIdentifier", + "over" ], "type": "object" }, - "JsonApiWorkspaceThemeIn": { - "description": "JSON:API representation of workspaceTheme entity.", + "PublisherDocumentAttributeFilterParentOver": { + "description": "Attributes that connect the parent and the child filter in the data model.", "properties": { "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "required": [ - "content", - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "type": "array" + } + }, + "required": [ + "attributes" + ], + "type": "object" + }, + "PublisherDocumentAttributeFilterReference": { + "properties": { + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, "type": { - "description": "Object type", "enum": [ - "workspaceTheme" + "attributeFilterReference" ], - "example": "workspaceTheme", "type": "string" } }, "required": [ - "attributes", - "id", + "displayForm", "type" ], "type": "object" }, - "JsonApiWorkspaceThemeInDocument": { + "PublisherDocumentAutoVisibility": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + "visible": { + "description": "`true`, `false` or `\"auto\"`.", + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] } }, - "required": [ - "data" - ], "type": "object" }, - "JsonApiWorkspaceThemeOut": { - "description": "JSON:API representation of workspaceTheme entity.", + "PublisherDocumentAxisDisplay": { "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" + "max": { + "format": "double", + "type": "number" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "min": { + "format": "double", + "type": "number" }, - "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" + "name": { + "$ref": "#/components/schemas/PublisherDocumentAxisNameDisplay" }, - "type": { - "description": "Object type", + "values": { + "$ref": "#/components/schemas/PublisherDocumentAxisValuesDisplay" + }, + "visible": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublisherDocumentAxisNameDisplay": { + "properties": { + "position": { "enum": [ - "workspaceTheme" + "low", + "middle", + "high" ], - "example": "workspaceTheme", "type": "string" + }, + "visible": { + "type": "boolean" } }, - "required": [ - "attributes", - "id", - "type" - ], "type": "object" }, - "JsonApiWorkspaceThemeOutDocument": { + "PublisherDocumentAxisValuesDisplay": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "rotation": { + "description": "Label rotation in degrees, from -90 to 90.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "visible": { + "type": "boolean" } }, - "required": [ - "data" - ], "type": "object" }, - "JsonApiWorkspaceThemeOutList": { - "description": "A JSON:API document with a list of resources", + "PublisherDocumentBoundedFilter": { + "description": "One open end of a relative date filter: exactly one of `from` and `to`.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "from": { + "format": "int32", + "type": "integer" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "granularity": { + "enum": [ + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" + ], + "type": "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "to": { + "format": "int32", + "type": "integer" } }, "required": [ - "data" + "granularity" ], "type": "object" }, - "JsonApiWorkspaceThemeOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "PublisherDocumentChartStyle": { + "description": "Chart style overrides; stored, not applied. Lengths are in canvas px.", + "properties": { + "axisLineColor": { + "type": "string" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "axisNameColor": { + "type": "string" + }, + "axisNameSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "axisValueColor": { + "type": "string" + }, + "axisValueSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "dataLabelColor": { + "type": "string" + }, + "dataLabelSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "gridColor": { + "type": "string" + }, + "legendColor": { + "type": "string" + }, + "legendSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "plotLineColor": { + "type": "string" + }, + "textColor": { + "type": "string" } - ] + }, + "type": "object" }, - "JsonApiWorkspaceThemePatch": { - "description": "JSON:API representation of patching workspaceTheme entity.", + "PublisherDocumentColumn": { + "description": "Lays its children out top to bottom.", "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } + "children": { + "description": "Child nodes from top to bottom, in reading order; an empty list is a spacer.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" }, - "type": "object" + "type": "array" }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, + "locked": { + "description": "Locks the container in the document editor; never checked on write.", + "type": "boolean" + }, + "proportion": { + "description": "Share of the parent's main axis, greater than 0. Default 1.", + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentContainerStyle" + }, "type": { - "description": "Object type", "enum": [ - "workspaceTheme" + "column" ], - "example": "workspaceTheme", "type": "string" } }, "required": [ - "attributes", - "id", + "children", "type" ], "type": "object" }, - "JsonApiWorkspaceThemePatchDocument": { + "PublisherDocumentComparisonCondition": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + "comparison": { + "properties": { + "operator": { + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO" + ], + "type": "string" + }, + "treatNullValuesAs": { + "format": "double", + "type": "number" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "operator", + "value" + ], + "type": "object" } }, "required": [ - "data" + "comparison" ], "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" - } - ] - }, - "JsonNode": { - "description": "Free-form JSON object", - "example": {}, - "maxLength": 15000, - "nullable": true, - "type": "object" - }, - "KeyDriversDimension": { + "PublisherDocumentContainerStyle": { + "description": "Style of a row or column; its content inherits the text keys. Lengths are in canvas px.", "properties": { - "attribute": { - "$ref": "#/components/schemas/RestApiIdentifier" + "backgroundColor": { + "type": "string" }, - "attributeName": { + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], "type": "string" }, - "format": { - "$ref": "#/components/schemas/AttributeFormat" + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" }, - "granularity": { + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { "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" + "top", + "center", + "bottom" ], "type": "string" }, - "label": { - "$ref": "#/components/schemas/RestApiIdentifier" + "borderBottomColor": { + "type": "string" }, - "labelName": { + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], "type": "string" }, - "valueType": { + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "GEO_ICON", - "IMAGE", - "HYPERLOGLOG" + "solid", + "dashed", + "dotted", + "none" ], "type": "string" - } - }, - "required": [ - "attribute", - "attributeName", - "label", - "labelName" - ], - "type": "object" - }, - "KeyDriversRequest": { - "properties": { - "auxMetrics": { - "description": "Additional metrics to be included in the computation, but excluded from the analysis.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" }, - "metric": { - "$ref": "#/components/schemas/MeasureItem" + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { + "type": "string" + }, + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { + "type": "string" + }, + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" }, - "sortDirection": { - "default": "DESC", - "description": "Sorting elements - ascending/descending order.", + "shadowY": { + "format": "double", + "type": "number" + }, + "textColor": { + "type": "string" + }, + "textOverflow": { "enum": [ - "ASC", - "DESC" + "shrink", + "clip", + "ellipsis" ], "type": "string" - } - }, - "required": [ - "metric" - ], - "type": "object" - }, - "KeyDriversResponse": { - "properties": { - "dimensions": { - "items": { - "$ref": "#/components/schemas/KeyDriversDimension" - }, - "type": "array" }, - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "dimensions", - "links" - ], - "type": "object" - }, - "KeyDriversResult": { - "properties": { - "data": { - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "LabelIdentifier": { - "description": "A label identifier.", - "properties": { - "id": { - "description": "Label ID.", - "example": "label_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], "type": "string" }, - "type": { - "description": "A type of the label.", + "textTransform": { "enum": [ - "label" + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" ], - "example": "label", "type": "string" } }, - "required": [ - "id", - "type" - ], "type": "object" }, - "LabelPermissions": { - "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" + "PublisherDocumentContent": { + "description": "Content of a document or a document template. Holds `pages` or `sections`, never both.", + "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], + "pages": [ + { + "id": "page_7f3a91c4", + "kind": "cover", + "layout": { + "children": [ + { + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" + }, + { + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, - "type": "array" - }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" + }, + { + "children": [ + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } + }, + { + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." }, - "type": "array" + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 } }, - "required": [ - "rules", - "userGroups", - "users" - ], - "type": "object" - }, - "LabelPermissionsAssignment": { - "description": "Desired levels of permissions on a label for an assignee.", "properties": { - "permissions": { + "attributeFilterConfigs": { "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" }, "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "LabelPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" - }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } - }, - "type": "object" - } - ], - "description": "Desired levels of label permissions for an assignee identified by an identifier.", - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" - }, - "LabelPermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" - }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" - } - ], - "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], - "type": "object" - }, - "ListLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/ObjectLinks" }, - { - "properties": { - "next": { - "description": "A string containing the link's URL for the next page of data.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - ] - }, - "ListLlmProviderModelsRequest": { - "properties": { - "providerConfig": { - "$ref": "#/components/schemas/LlmProviderConfig" - } - }, - "required": [ - "providerConfig" - ], - "type": "object" - }, - "ListLlmProviderModelsResponse": { - "properties": { - "message": { - "description": "Message about the listing result.", - "type": "string" + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" }, - "models": { - "description": "Available models on the provider.", + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", "items": { - "$ref": "#/components/schemas/LlmModel" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" }, - "success": { - "description": "Whether the model listing succeeded.", - "type": "boolean" - } - }, - "required": [ - "message", - "models", - "success" - ], - "type": "object" - }, - "LiveFeatureFlagConfiguration": { - "properties": { - "host": { + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", "type": "string" }, - "key": { + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", "type": "string" - } - }, - "required": [ - "host", - "key" - ], - "type": "object" - }, - "LiveFeatures": { - "allOf": [ - { - "$ref": "#/components/schemas/Features" }, - { - "properties": { - "configuration": { - "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" - } + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" }, - "type": "object" - } - ], - "description": "Structure for featureHub", - "required": [ - "configuration", - "context" - ], - "type": "object" - }, - "LlmModel": { - "description": "LLM Model configuration (id, family) within a provider.", - "properties": { - "family": { - "description": "Family of LLM models.", - "enum": [ - "OPENAI", - "ANTHROPIC", - "META", - "MISTRAL", - "AMAZON", - "GOOGLE", - "COHERE", - "UNKNOWN" - ], - "type": "string" + "type": "array" }, - "id": { - "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", - "maxLength": 255, - "type": "string" + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" } }, - "required": [ - "family", - "id" - ], "type": "object" }, - "LlmProviderConfig": { - "description": "Provider configuration overrides.", - "oneOf": [ - { - "$ref": "#/components/schemas/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" - } - ] - }, - "LocalIdentifier": { + "PublisherDocumentDataSetRef": { + "description": "A date dataset.", "properties": { - "format": { - "default": "#,##0.00", - "description": "Metric format.", - "example": "#,##0", - "maxLength": 2048, - "nullable": true, - "type": "string" - }, - "localIdentifier": { - "description": "Local identifier of the metric to be compared.", - "example": "m1", + "identifier": { "type": "string" }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "LocaleRequest": { - "properties": { - "locale": { - "description": "Requested locale in the form of language tag (see RFC 5646).", - "example": "en-US", + "type": { + "enum": [ + "dataSet" + ], "type": "string" } }, "required": [ - "locale" + "identifier", + "type" ], "type": "object" }, - "MatchAttributeFilter": { - "description": "Filter via label with given match type and literal value.", + "PublisherDocumentDateFilter": { + "description": "Filters a date dataset. A document filter always names its `dataSet`.", "properties": { - "matchAttributeFilter": { + "dateFilter": { "properties": { - "applyOnResult": { - "type": "boolean" + "attribute": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "caseSensitive": { - "default": false, - "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", - "type": "boolean" + "boundedFilter": { + "$ref": "#/components/schemas/PublisherDocumentBoundedFilter" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "literal": { - "description": "Literal used to limit label values.", - "example": "value", + "emptyValueHandling": { + "enum": [ + "include", + "exclude", + "only" + ], "type": "string" }, - "localIdentifier": { - "type": "string" + "from": { + "description": "A date, or an offset of a relative filter.", + "oneOf": [ + { + "type": "string" + }, + { + "format": "double", + "type": "number" + } + ] }, - "matchType": { - "description": "Requested match type.", + "granularity": { "enum": [ - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" ], "type": "string" }, - "negate": { - "default": false, - "description": "Indicates whether the filter should negate the match.", - "type": "boolean" - } - }, - "required": [ - "label", - "literal", - "matchType" - ], - "type": "object" - } - }, - "required": [ - "matchAttributeFilter" - ], - "type": "object" - }, - "MatomoService": { - "description": "Matomo service.", - "properties": { - "host": { - "description": "Telemetry host to send events to.", - "type": "string" - }, - "reportingEndpoint": { - "description": "Optional reporting endpoint for proxying telemetry events.", - "type": "string" - }, - "siteId": { - "description": "Site ID on telemetry server.", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "host", - "siteId" - ], - "type": "object" - }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - } - ], - "type": "object" - }, - "MeasureExecutionResultHeader": { - "properties": { - "measureHeader": { - "$ref": "#/components/schemas/MeasureResultHeader" - } - }, - "required": [ - "measureHeader" - ], - "type": "object" - }, - "MeasureGroupHeaders": { - "description": "Measure group headers", - "properties": { - "measureGroupHeaders": { - "items": { - "$ref": "#/components/schemas/MeasureHeader" - }, - "type": "array" - } - }, - "type": "object" - }, - "MeasureHeader": { - "properties": { - "format": { - "description": "Format to be used to format the measure data.", - "type": "string" - }, - "localIdentifier": { - "description": "Local identifier of the measure this header relates to.", - "type": "string" - }, - "name": { - "description": "Name of the measure.", - "type": "string" + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "to": { + "description": "A date, or an offset of a relative filter.", + "oneOf": [ + { + "type": "string" + }, + { + "format": "double", + "type": "number" + } + ] + }, + "type": { + "enum": [ + "relative", + "absolute" + ], + "type": "string" + } + }, + "required": [ + "granularity", + "type" + ], + "type": "object" } }, "required": [ - "localIdentifier" + "dateFilter" ], "type": "object" }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", + "PublisherDocumentDateFilterReference": { "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", + "type": { + "enum": [ + "dateFilterReference" + ], "type": "string" } }, "required": [ - "definition", - "localIdentifier" + "dataSet", + "type" ], "type": "object" }, - "MeasureResultHeader": { - "description": "Header containing the information related to metrics.", + "PublisherDocumentDefaults": { + "description": "Document-wide defaults.", "properties": { - "measureIndex": { - "description": "Metric index. Starts at 0.", - "example": 0, - "format": "int32", - "type": "integer" + "pageSize": { + "description": "Page size of a page that sets none.", + "enum": [ + "widescreen" + ], + "type": "string" + }, + "period": { + "$ref": "#/components/schemas/PublisherDocumentPeriod" + }, + "takeaway": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayDefaults" } }, - "required": [ - "measureIndex" - ], "type": "object" }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "PublisherDocumentFilter": { + "description": "A filter in the dashboard filter grammar, wrapped in an object keyed by its kind.", "oneOf": [ { - "$ref": "#/components/schemas/ComparisonCondition" + "$ref": "#/components/schemas/PublisherDocumentAttributeFilter" }, { - "$ref": "#/components/schemas/RangeCondition" + "$ref": "#/components/schemas/PublisherDocumentArbitraryAttributeFilter" + }, + { + "$ref": "#/components/schemas/PublisherDocumentMatchAttributeFilter" + }, + { + "$ref": "#/components/schemas/PublisherDocumentDateFilter" + }, + { + "$ref": "#/components/schemas/PublisherDocumentMeasureValueFilter" } ], "type": "object" }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", + "PublisherDocumentFilterReference": { + "description": "A reference to a document filter, selected by `type`.", + "discriminator": { + "mapping": { + "attributeFilterReference": "#/components/schemas/PublisherDocumentAttributeFilterReference", + "dateFilterReference": "#/components/schemas/PublisherDocumentDateFilterReference", + "measureValueFilterReference": "#/components/schemas/PublisherDocumentMeasureValueFilterReference" + }, + "propertyName": "type" + }, "oneOf": [ { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterReference" }, { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "$ref": "#/components/schemas/PublisherDocumentDateFilterReference" }, { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" + "$ref": "#/components/schemas/PublisherDocumentMeasureValueFilterReference" } ], "type": "object" }, - "MemoryItemCreatedByUsers": { + "PublisherDocumentHeadingWidget": { + "description": "A heading below the page title.", "properties": { - "reasoning": { - "description": "Reasoning for error states", + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "users": { - "description": "Users who created memory item", - "items": { - "$ref": "#/components/schemas/MemoryItemUser" - }, - "type": "array" + "level": { + "description": "Outline level below the page title. Default 1.", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6 + ], + "format": "int32", + "type": "integer" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Inline markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { + "enum": [ + "heading" + ], + "type": "string" } }, "required": [ - "reasoning", - "users" + "id", + "type" ], "type": "object" }, - "MemoryItemUser": { - "description": "Users who created memory item", + "PublisherDocumentHeadlineStyle": { + "description": "Headline style overrides; stored, not applied. Lengths are in canvas px.", "properties": { - "firstname": { - "description": "First name of the user who created memory item", + "negativeColor": { "type": "string" }, - "lastname": { - "description": "Last name of the user who created memory item", + "positiveColor": { "type": "string" }, - "userId": { - "description": "User ID of the user who created memory item", + "primaryValueColor": { "type": "string" - } - }, - "required": [ - "firstname", - "lastname", - "userId" - ], - "type": "object" - }, - "MetricDefinitionOverride": { - "description": "(EXPERIMENTAL) Override for a catalog metric definition.", - "properties": { - "definition": { - "$ref": "#/components/schemas/InlineMeasureDefinition" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" - } - }, - "required": [ - "definition", - "item" - ], - "type": "object" - }, - "MetricPermissions": { - "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" + "primaryValueSize": { + "format": "double", + "minimum": 0, + "type": "number" }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" + "secondaryValueColor": { + "type": "string" }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" - }, - "type": "array" + "secondaryValueSize": { + "format": "double", + "minimum": 0, + "type": "number" } }, - "required": [ - "rules", - "userGroups", - "users" - ], "type": "object" }, - "MetricPermissionsAssignment": { - "description": "Desired levels of permissions on a metric for an assignee.", + "PublisherDocumentImageWidget": { + "description": "An image from the theme or an https URL.", "properties": { - "permissions": { - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "MetricPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "altText": { + "type": "string" }, - { - "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" + "decorative": { + "description": "Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.", + "type": "boolean" }, - { - "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": { + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "value": { + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, "format": "double", + "minimum": 0, "type": "number" + }, + "source": { + "description": "A theme image reference such as `{theme.logo}`, or an `https://` URL.", + "example": "{theme.logo}", + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentImageWidgetStyle" + }, + "type": { + "enum": [ + "image" + ], + "type": "string" } }, "required": [ - "value" + "id", + "type" ], "type": "object" }, - "MetricValueChange": { - "description": "Individual change analysis data item", + "PublisherDocumentImageWidgetStyle": { + "description": "Style of an image widget. Lengths are in canvas px.", "properties": { - "attributeName": { - "deprecated": true, - "description": "Deprecated: bare id of the analyzed label or computed attribute, without its type. Use attributeRef instead.", + "backgroundColor": { "type": "string" }, - "attributeRef": { - "$ref": "#/components/schemas/AfmObjectIdentifierLabel" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" }, - "attributeValue": { - "description": "The value of the attribute being analyzed", + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], "type": "string" }, - "attributeValuesChangeMean": { - "description": "The mean of attribute value changes for the attribute being analyzed", - "format": "double", - "type": "number" + "backgroundImage": { + "type": "string" }, - "attributeValuesChangeStd": { - "description": "The standard deviation of attribute value changes for the attribute being analyzed", + "backgroundImageOpacity": { "format": "double", + "maximum": 1, + "minimum": 0, "type": "number" }, - "isSignificantChange": { - "description": "Whether the change is statistically significant", - "type": "boolean" - }, - "metricValueDelta": { - "description": "The delta between analyzed and reference periods", + "backgroundOffset": { "format": "double", + "minimum": 0, "type": "number" }, - "metricValueDeltaAbs": { - "description": "The absolute delta between analyzed and reference periods", + "backgroundOffsetBottom": { "format": "double", + "minimum": 0, "type": "number" }, - "metricValueInAnalyzedPeriod": { - "description": "The metric value in the analyzed period", + "backgroundOffsetLeft": { "format": "double", + "minimum": 0, "type": "number" }, - "metricValueInReferencePeriod": { - "description": "The metric value in the reference period", + "backgroundOffsetRight": { "format": "double", + "minimum": 0, "type": "number" }, - "overallMetricValueInAnalyzedPeriod": { - "description": "The overall metric value in the analyzed period", + "backgroundOffsetTop": { "format": "double", + "minimum": 0, "type": "number" }, - "overallMetricValueInReferencePeriod": { - "description": "The overall metric value in the reference period", + "backgroundOpacity": { "format": "double", + "maximum": 1, + "minimum": 0, "type": "number" - } - }, - "required": [ - "attributeName", - "attributeRef", - "attributeValue", - "attributeValuesChangeMean", - "attributeValuesChangeStd", - "isSignificantChange", - "metricValueDelta", - "metricValueDeltaAbs", - "metricValueInAnalyzedPeriod", - "metricValueInReferencePeriod", - "overallMetricValueInAnalyzedPeriod", - "overallMetricValueInReferencePeriod" - ], - "type": "object" - }, - "ModelTestResult": { - "description": "Per-model test results.", - "properties": { - "message": { - "description": "Message about the model test result.", + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], "type": "string" }, - "modelId": { - "description": "The model ID that was tested.", + "borderBottomColor": { "type": "string" }, - "successful": { - "description": "Whether the model test was successful.", - "type": "boolean" - } - }, - "required": [ - "message", - "modelId", - "successful" - ], - "type": "object" - }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", - "properties": { - "negativeAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "localIdentifier": { + { "type": "string" + } + ] + }, + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" - }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + { + "type": "string" } - }, - "required": [ - "label", - "notIn" + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" ], - "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Note": { - "properties": { - "appliesTo": { + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { "enum": [ - "SOURCE", - "TARGET" + "solid", + "dashed", + "dotted", + "none" ], - "type": "string", - "xml": { - "attribute": true - } + "type": "string" }, - "category": { - "type": "string", - "xml": { - "attribute": true - } + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" }, - "content": { + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderRightColor": { "type": "string" }, - "id": { - "type": "string", - "xml": { - "attribute": true - } + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" }, - "otherAttributes": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" }, - "priority": { - "format": "int32", - "type": "integer", - "xml": { - "attribute": true - } - } - }, - "type": "object", - "xml": { - "name": "note", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } - }, - "Notes": { - "properties": { - "note": { - "items": { - "$ref": "#/components/schemas/Note" - }, - "type": "array" - } - }, - "required": [ - "note" - ], - "type": "object", - "xml": { - "name": "notes", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } - }, - "Notification": { - "properties": { - "automationId": { + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], "type": "string" }, - "createdAt": { - "format": "date-time", + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fit": { + "enum": [ + "contain", + "cover", + "fill" + ], "type": "string" }, - "data": { + "horizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", "oneOf": [ { - "$ref": "#/components/schemas/AutomationNotification" + "format": "double", + "type": "number" }, { - "$ref": "#/components/schemas/TestNotification" + "type": "string" } ] }, - "id": { + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { "type": "string" }, - "isRead": { - "type": "boolean" + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" }, - "workspaceId": { + "shadowColor": { + "type": "string" + }, + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], "type": "string" } }, - "required": [ - "createdAt", - "data", - "id", - "isRead" - ], "type": "object" }, - "NotificationChannelDestination": { + "PublisherDocumentLayoutNode": { + "description": "A layout node: a row or column container, or a widget. The shape is selected by `type`.", + "discriminator": { + "mapping": { + "column": "#/components/schemas/PublisherDocumentColumn", + "heading": "#/components/schemas/PublisherDocumentHeadingWidget", + "image": "#/components/schemas/PublisherDocumentImageWidget", + "row": "#/components/schemas/PublisherDocumentRow", + "takeaway": "#/components/schemas/PublisherDocumentTakeawayWidget", + "text": "#/components/schemas/PublisherDocumentTextWidget", + "title": "#/components/schemas/PublisherDocumentTitleWidget", + "visualization": "#/components/schemas/PublisherDocumentVisualizationWidget" + }, + "propertyName": "type" + }, "oneOf": [ { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/PublisherDocumentRow" }, { - "$ref": "#/components/schemas/Smtp" + "$ref": "#/components/schemas/PublisherDocumentColumn" }, { - "$ref": "#/components/schemas/DefaultSmtp" + "$ref": "#/components/schemas/PublisherDocumentTitleWidget" }, { - "$ref": "#/components/schemas/InPlatform" + "$ref": "#/components/schemas/PublisherDocumentHeadingWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentTextWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentImageWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentVisualizationWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentTakeawayWidget" } ], "type": "object" }, - "NotificationContent": { - "discriminator": { - "mapping": { - "AUTOMATION": "#/components/schemas/AutomationNotification", - "TEST": "#/components/schemas/TestNotification" - }, - "propertyName": "type" - }, + "PublisherDocumentLegendDisplay": { "properties": { - "type": { + "position": { + "enum": [ + "auto", + "top", + "bottom", + "left", + "right" + ], "type": "string" + }, + "visible": { + "type": "boolean" } }, - "required": [ - "type" - ], "type": "object" }, - "NotificationFilter": { + "PublisherDocumentMatchAttributeFilter": { + "description": "Filters an attribute display form by a text pattern.", "properties": { - "filter": { - "type": "string" - }, - "title": { - "type": "string" + "matchAttributeFilter": { + "properties": { + "caseSensitive": { + "type": "boolean" + }, + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "literal": { + "type": "string" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "operator": { + "enum": [ + "contains", + "startsWith", + "endsWith" + ], + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "displayForm", + "literal", + "operator" + ], + "type": "object" } }, "required": [ - "filter", - "title" + "matchAttributeFilter" ], "type": "object" }, - "NotificationParameter": { - "properties": { - "id": { - "type": "string" - }, - "title": { - "type": "string" - }, - "value": { - "type": "string" + "PublisherDocumentMeasureValueCondition": { + "description": "A measure value condition, wrapped in an object keyed by its kind.", + "oneOf": [ + { + "$ref": "#/components/schemas/PublisherDocumentComparisonCondition" }, - "valueTitle": { - "type": "string" + { + "$ref": "#/components/schemas/PublisherDocumentRangeCondition" } - }, - "required": [ - "id", - "value" ], "type": "object" }, - "Notifications": { + "PublisherDocumentMeasureValueFilter": { + "description": "Filters by the value of a measure.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Notification" + "dashboardMeasureValueFilter": { + "properties": { + "conditions": { + "description": "OR-ed conditions; none means all values.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentMeasureValueCondition" + }, + "type": "array" + }, + "dimensionality": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" + }, + "localIdentifier": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "measure": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "title": { + "type": "string" + } }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/NotificationsMeta" + "required": [ + "localIdentifier", + "measure" + ], + "type": "object" } }, "required": [ - "data", - "meta" + "dashboardMeasureValueFilter" ], "type": "object" }, - "NotificationsMeta": { - "properties": { - "total": { - "$ref": "#/components/schemas/NotificationsMetaTotal" - } - }, - "type": "object" - }, - "NotificationsMetaTotal": { + "PublisherDocumentMeasureValueFilterReference": { "properties": { - "all": { - "format": "int64", - "type": "integer" + "measure": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "unread": { - "format": "int64", - "type": "integer" + "type": { + "enum": [ + "measureValueFilterReference" + ], + "type": "string" } }, "required": [ - "all", - "unread" + "measure", + "type" ], "type": "object" }, - "NumberConstraints": { - "properties": { - "max": { - "format": "double", - "type": "number" - }, - "min": { - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "NumberParameterDefinition": { + "PublisherDocumentObjRef": { + "description": "A flat object reference.", "properties": { - "constraints": { - "$ref": "#/components/schemas/NumberConstraints" - }, - "defaultValue": { - "format": "double", - "type": "number" + "identifier": { + "type": "string" }, "type": { - "description": "The parameter type.", - "enum": [ - "NUMBER" - ], + "description": "sdk-model object type, such as `displayForm`, `dataSet` or `measure`.", "type": "string" } }, "required": [ - "defaultValue", + "identifier", "type" ], "type": "object" }, - "ObjectConditionalFormatting": { - "description": "Conditional formatting inherited by every table column that renders this object.", - "nullable": true, + "PublisherDocumentPage": { + "description": "A page of a document.", "properties": { - "conditions": { - "description": "Conditions evaluated in order; the first match wins.", + "filters": { + "description": "Page filters; stored, not applied.", "items": { - "$ref": "#/components/schemas/ConditionalFormattingCondition" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" }, - "enabled": { - "description": "Whether the conditions are applied when rendering.", - "type": "boolean" - } - }, - "required": [ - "conditions", - "enabled" - ], - "type": "object" - }, - "ObjectLinks": { - "properties": { - "self": { - "description": "A string containing the link's URL.", - "format": "uri", + "id": { + "description": "Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" - } - }, - "required": [ - "self" - ], - "type": "object" - }, - "ObjectLinksContainer": { - "properties": { - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "type": "object" - }, - "ObjectStorageInfo": { - "description": "Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.", - "properties": { - "name": { - "description": "Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds.", - "example": "s3-data-lake", + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], "type": "string" }, - "storageConfig": { - "additionalProperties": { - "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", - "type": "string" - }, - "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", - "type": "object" + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" }, - "storageId": { - "description": "Stable identifier of the storage configuration (UUID).", + "notes": { + "description": "Speaker notes in markdown, never drawn.", "type": "string" }, - "storageType": { - "description": "Provider type.", - "example": "s3", + "pageSize": { + "enum": [ + "widescreen" + ], "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + }, + "visible": { + "description": "`false` keeps the page out of the viewer, exports and page numbering. Default `true`.", + "type": "boolean" } }, "required": [ - "name", - "storageConfig", - "storageId", - "storageType" + "layout" ], "type": "object" }, - "OpenAIProviderConfig": { - "description": "Configuration for OpenAI provider.", + "PublisherDocumentPageStyle": { + "description": "Style of a page; containers inherit its gap and text keys. Lengths are in canvas px.", "properties": { - "auth": { - "$ref": "#/components/schemas/OpenAiProviderAuth" + "backgroundColor": { + "type": "string" }, - "baseUrl": { - "default": "https://api.openai.com/v1", - "description": "Custom base URL for OpenAI API.", - "maxLength": 255, + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], "type": "string" }, - "organization": { - "description": "OpenAI organization ID.", - "maxLength": 255, - "nullable": true, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], "type": "string" }, - "type": { - "description": "Provider type.", + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { "enum": [ - "OPENAI" + "top", + "center", + "bottom" ], "type": "string" - } - }, - "required": [ - "auth", - "type" - ], - "type": "object" - }, - "OpenAiApiKeyAuth": { - "allOf": [ - { - "properties": { - "apiKey": { - "description": "OpenAI API key.", - "maxLength": 255, - "nullable": true, - "type": "string", - "writeOnly": true + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "type": { - "description": "Authentication type.", - "enum": [ - "API_KEY" - ], + { + "type": "string" + } + ] + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { "type": "string" } - }, - "type": "object" - } - ], - "required": [ - "type" - ], - "type": "object" - }, - "OpenAiProviderAuth": { - "description": "Authentication configuration.", - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAiApiKeyAuth" - } - ], - "type": "object" - }, - "OpenTelemetryService": { - "description": "OpenTelemetry service.", - "properties": { - "host": { - "description": "Telemetry host to send events to.", - "type": "string" - } - }, - "required": [ - "host" - ], - "type": "object" - }, - "Operation": { - "description": "Represents a Long-Running Operation: a process that takes some time to complete.", - "discriminator": { - "mapping": { - "failed": "#/components/schemas/FailedOperation", - "pending": "#/components/schemas/PendingOperation", - "succeeded": "#/components/schemas/SucceededOperation" + ] }, - "propertyName": "status" - }, - "properties": { - "id": { - "description": "Id of the operation", + "textColor": { "type": "string" }, - "kind": { - "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n", + "textOverflow": { "enum": [ - "provision-database", - "deprovision-database", - "run-service-command", - "analyze-statistics" + "shrink", + "clip", + "ellipsis" ], "type": "string" }, - "status": { - "type": "string" - } - }, - "required": [ - "id", - "kind", - "status" - ], - "type": "object" - }, - "OperationError": { - "description": "Error information for a failed operation", - "properties": { - "detail": { - "description": "Human-readable error details", - "type": "string" - }, - "status": { - "description": "HTTP status code", - "format": "int32", - "type": "integer" - }, - "title": { - "description": "Human-readable error name", - "type": "string" - } - }, - "required": [ - "detail", - "status", - "title" - ], - "type": "object" - }, - "OrganizationAutomationIdentifier": { - "properties": { - "id": { + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], "type": "string" }, - "workspaceId": { + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], "type": "string" - } - }, - "required": [ - "id", - "workspaceId" - ], - "type": "object" - }, - "OrganizationAutomationManagementBulkRequest": { - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/OrganizationAutomationIdentifier" - }, - "type": "array" - } - }, - "required": [ - "automations" - ], - "type": "object" - }, - "OrganizationCacheSettings": { - "description": "Settings for organization cache.", - "properties": { - "extraCacheBudget": { - "description": "Extra cache budget the organization can allocate among its workspaces, in bytes.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "extraCacheBudget" - ], - "type": "object" - }, - "OrganizationCacheUsage": { - "description": "Data about the whole organization's cache usage.", - "properties": { - "current": { - "$ref": "#/components/schemas/OrganizationCurrentCacheUsage" - }, - "removalIntervals": { - "description": "List of cache removal intervals.", - "items": { - "$ref": "#/components/schemas/CacheRemovalInterval" - }, - "type": "array" - }, - "settings": { - "$ref": "#/components/schemas/OrganizationCacheSettings" - } - }, - "required": [ - "current", - "removalIntervals", - "settings" - ], - "type": "object" - }, - "OrganizationCurrentCacheUsage": { - "description": "Current cache usage of the organization.", - "properties": { - "cacheUsed": { - "description": "Cache currently used by the organization, in bytes.", - "format": "int64", - "type": "integer" }, - "removalPeriodStart": { - "description": "Start timestamp of removal period.", - "format": "date-time", + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], "type": "string" - }, - "removedSinceStart": { - "description": "Bytes removed since start due to insufficient cache.", - "format": "int64", - "type": "integer" } }, - "required": [ - "cacheUsed", - "removedSinceStart" - ], "type": "object" }, - "OrganizationPermissionAssignment": { - "description": "Organization permission assignments", - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" - }, - "type": "array" + "PublisherDocumentPageTemplateContent": { + "description": "Content of a page template: one page without `id` and `visible`.", + "example": { + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" + }, + { + "children": [ + { + "children": [ + { + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" + }, + { + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" + } + ], + "proportion": 2, + "type": "row" + }, + { + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" + } + ], + "proportion": 9, + "type": "row" + }, + { + "children": [ + { + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" + }, + { + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" + } + ], + "proportion": 1, + "type": "row" + } + ], + "type": "column" } }, - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" - }, - "OutlierDetectionRequest": { "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, "filters": { - "description": "Various filter types to filter the execution result.", + "description": "Page filters; stored, not applied.", "items": { - "$ref": "#/components/schemas/FilterDefinition" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" }, - "granularity": { - "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", + "kind": { + "description": "Editor hint.", "enum": [ - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" + "cover", + "section", + "content" ], "type": "string" }, - "measures": { - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "minItems": 1, - "type": "array" + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" }, - "sensitivity": { - "description": "Sensitivity level for outlier detection", + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { "enum": [ - "LOW", - "MEDIUM", - "HIGH" + "widescreen" ], "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" } }, "required": [ - "attributes", - "granularity", - "measures", - "sensitivity" + "layout" ], "type": "object" }, - "OutlierDetectionResponse": { - "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } + "PublisherDocumentPeriod": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" }, - "required": [ - "links" + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } ], "type": "object" }, - "OutlierDetectionResult": { + "PublisherDocumentRangeCondition": { "properties": { - "attribute": { - "description": "Attribute values for outlier detection results.", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "values": { - "additionalProperties": { - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "items": { - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "nullable": true, + "range": { + "properties": { + "from": { + "format": "double", "type": "number" }, - "nullable": true, - "type": "array" + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + }, + "treatNullValuesAs": { + "format": "double", + "type": "number" + } }, - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "nullable": true, + "required": [ + "from", + "operator", + "to" + ], "type": "object" } }, "required": [ - "attribute", - "values" + "range" ], "type": "object" }, - "Over": { + "PublisherDocumentRow": { + "description": "Lays its children out left to right.", "properties": { - "attributes": { + "children": { + "description": "Child nodes from left to right, in reading order; an empty list is a spacer.", "items": { - "$ref": "#/components/schemas/IdentifierRef" + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" }, "type": "array" - } - }, - "required": [ - "attributes" - ], - "type": "object" - }, - "PageMetadata": { - "properties": { - "number": { - "description": "The number of the current page", - "format": "int32", - "type": "integer" - }, - "size": { - "description": "The size of the current page", - "format": "int32", - "type": "integer" }, - "totalElements": { - "description": "The total number of elements", - "format": "int32", - "type": "integer" + "id": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" }, - "totalPages": { - "description": "The total number of pages", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Paging": { - "description": "Current page description.", - "properties": { - "count": { - "description": "Count of items in this page.", - "example": 5, - "format": "int32", - "type": "integer" + "locked": { + "description": "Locks the container in the document editor; never checked on write.", + "type": "boolean" }, - "next": { - "description": "Link to next page, or null if this is last page.", - "example": "https://sample.gooddata.ai/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10", - "type": "string" + "proportion": { + "description": "Share of the parent's main axis, greater than 0. Default 1.", + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" }, - "offset": { - "description": "Offset of this page.", - "example": 10, - "format": "int32", - "type": "integer" + "style": { + "$ref": "#/components/schemas/PublisherDocumentContainerStyle" }, - "total": { - "description": "Count of returnable items ignoring paging.", - "example": 100, - "format": "int32", - "type": "integer" + "type": { + "enum": [ + "row" + ], + "type": "string" } }, "required": [ - "count", - "offset", - "total" + "children", + "type" ], "type": "object" }, - "Parameter": { + "PublisherDocumentSection": { + "description": "A group of pages, like a dashboard tab.", "properties": { - "name": { + "description": { "type": "string" }, - "value": { + "id": { + "description": "Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "ParameterDefinition": { - "description": "Parameter content (type-discriminated).", - "discriminator": { - "mapping": { - "NUMBER": "#/components/schemas/NumberParameterDefinition", - "STRING": "#/components/schemas/StringParameterDefinition" - }, - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/NumberParameterDefinition" }, - { - "$ref": "#/components/schemas/StringParameterDefinition" - } - ], - "type": "object" - }, - "ParameterItem": { - "additionalProperties": true, - "description": "(EXPERIMENTAL) Parameter value for this execution.", - "properties": { - "parameter": { - "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + "pages": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" }, - "value": { - "description": "Value to use for this parameter instead of its default.", + "title": { "type": "string" } }, "required": [ - "parameter", - "value" + "pages" ], "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.", + "PublisherDocumentTableStyle": { + "description": "Table style overrides; stored, not applied. Lengths are in canvas px.", "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "gridColor": { "type": "string" }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", + "headerBackgroundColor": { "type": "string" }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", + "headerLabelColor": { "type": "string" }, - "valueTitle": { - "description": "Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.", - "example": "year 2026", + "nullValueColor": { + "type": "string" + }, + "rowHeight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "subtotalBackgroundColor": { + "type": "string" + }, + "totalBackgroundColor": { + "type": "string" + }, + "totalValueColor": { + "type": "string" + }, + "valueColor": { "type": "string" } }, - "required": [ - "id", - "title", - "value" - ], "type": "object" }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], + "PublisherDocumentTakeawayContext": { + "description": "What the copilot reads when it writes a takeaway.", "properties": { - "properties": { - "description": "List of CSS properties.", + "filters": { + "type": "boolean" + }, + "otherPages": { + "type": "boolean" + }, + "pageTitle": { + "type": "boolean" + }, + "widgets": { + "description": "Widget ids on the same page.", "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" }, "type": "array" - }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" } }, - "required": [ - "selector" - ], "type": "object" }, - "PdfTableStyleProperty": { - "description": "CSS property.", + "PublisherDocumentTakeawayDefaults": { + "description": "Takeaway settings every takeaway widget of the document uses.", "properties": { - "key": { - "description": "CSS property key.", - "type": "string" - }, - "value": { - "description": "CSS property value.", - "type": "string" + "generation": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayGeneration" } }, - "required": [ - "key", - "value" - ], "type": "object" }, - "PdmLdmRequest": { - "description": "PDM additions wrapper.", + "PublisherDocumentTakeawayGeneration": { + "description": "How the copilot writes a takeaway.", "properties": { - "sqls": { - "description": "List of SQL datasets.", - "items": { - "$ref": "#/components/schemas/PdmSql" - }, - "type": "array" - }, - "tableOverrides": { - "description": "(BETA) List of table overrides.", - "items": { - "$ref": "#/components/schemas/TableOverride" - }, - "type": "array" + "context": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayContext" }, - "tables": { - "description": "List of physical database tables.", - "items": { - "$ref": "#/components/schemas/DeclarativeTable" - }, - "type": "array" + "instructions": { + "type": "string" } }, "type": "object" }, - "PdmSql": { - "description": "SQL dataset definition.", + "PublisherDocumentTakeawayWidget": { + "description": "A generated takeaway, stored as markdown.", "properties": { - "columns": { - "description": "Columns defining SQL dataset.", - "items": { - "$ref": "#/components/schemas/SqlColumn" - }, - "type": "array" + "generation": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayGeneration" }, - "statement": { - "description": "SQL statement.", - "example": "select * from abc", + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "The generated text.", "type": "string" }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, "title": { - "description": "SQL dataset title.", - "example": "My special dataset", + "$ref": "#/components/schemas/PublisherDocumentWidgetTitle" + }, + "type": { + "enum": [ + "takeaway" + ], "type": "string" } }, "required": [ - "statement", - "title" + "id", + "type" ], "type": "object" }, - "PendingOperation": { - "allOf": [ - { - "$ref": "#/components/schemas/Operation" - } - ], - "description": "Operation that is still pending", + "PublisherDocumentTextStyle": { + "description": "Text style of a widget title. Lengths are in canvas px.", "properties": { - "status": { + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { "enum": [ - "pending" + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "textColor": { + "type": "string" + }, + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" + }, + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" + }, + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" ], "type": "string" } }, - "required": [ - "id", - "kind", - "status" - ], "type": "object" }, - "PermissionsAssignment": { + "PublisherDocumentTextWidget": { + "description": "A block of markdown text.", "properties": { - "assignees": { - "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "minItems": 1, - "type": "array" + "decorative": { + "description": "Left out of the accessibility tree, PDF tags and the AI context.", + "type": "boolean" }, - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Full markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { + "enum": [ + "text" + ], + "type": "string" } }, "required": [ - "assignees" + "id", + "type" ], "type": "object" }, - "PermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + "PublisherDocumentTextWidgetStyle": { + "description": "Style of a title, heading, text or takeaway widget. Lengths are in canvas px.", + "properties": { + "backgroundColor": { + "type": "string" }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" } - }, - "type": "object" - } - ], - "description": "Desired levels of permissions for an assignee identified by an identifier.", - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" - }, - "PermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + ] }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" } - }, - "type": "object" - } - ], - "description": "Desired levels of permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], - "type": "object" - }, - "PlatformUsage": { - "properties": { - "count": { - "format": "int32", - "type": "integer" + ] }, - "name": { + "borderBottomStyle": { "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { + "type": "string" + }, + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { + "type": "string" + }, + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "textColor": { + "type": "string" + }, + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" + }, + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" + }, + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" ], "type": "string" } }, - "required": [ - "name" - ], "type": "object" }, - "PlatformUsageRequest": { + "PublisherDocumentTitleWidget": { + "description": "The page's title, at most one per page.", "properties": { - "usageItemNames": { - "items": { - "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Inline markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { + "enum": [ + "title" + ], + "type": "string" } }, "required": [ - "usageItemNames" + "id", + "type" ], "type": "object" }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "PublisherDocumentVisibility": { "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "visible": { + "type": "boolean" } }, - "required": [ - "dataset", - "periodsAgo" - ], "type": "object" }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", + "PublisherDocumentVisualizationDisplay": { + "description": "Overrides of the saved visualization's own configuration; stored, not applied.", "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], - "type": "object" + "dataLabels": { + "$ref": "#/components/schemas/PublisherDocumentAutoVisibility" + }, + "dataPoints": { + "$ref": "#/components/schemas/PublisherDocumentAutoVisibility" + }, + "gridlines": { + "$ref": "#/components/schemas/PublisherDocumentVisibility" + }, + "legend": { + "$ref": "#/components/schemas/PublisherDocumentLegendDisplay" + }, + "secondaryYAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" + }, + "xAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" + }, + "yAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" } }, - "required": [ - "previousPeriodMeasure" - ], "type": "object" }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "PublisherDocumentVisualizationRef": { + "description": "A saved visualization.", "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" + "identifier": { + "type": "string" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "type": { + "enum": [ + "insight" + ], + "type": "string" } }, "required": [ - "attribute", - "periodsAgo" + "identifier", + "type" ], "type": "object" }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", + "PublisherDocumentVisualizationStyle": { + "description": "Style of a visualization widget. Lengths are in canvas px.", "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" - }, - "type": "array" + "backgroundColor": { + "type": "string" + }, + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + { + "type": "string" } - }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" - }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" + ] }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - } - ], - "type": "object" - }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "localIdentifier": { + { "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + { + "type": "string" } - }, - "required": [ - "in", - "label" + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "Profile": { - "properties": { - "entitlements": { - "description": "Defines entitlements for given organization.", - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" + "type": "string" }, - "features": { + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "chart": { + "$ref": "#/components/schemas/PublisherDocumentChartStyle" + }, + "headline": { + "$ref": "#/components/schemas/PublisherDocumentHeadlineStyle" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", "oneOf": [ { - "$ref": "#/components/schemas/LiveFeatures" + "format": "double", + "type": "number" }, { - "$ref": "#/components/schemas/StaticFeatures" + "type": "string" } ] }, - "links": { - "$ref": "#/components/schemas/ProfileLinks" + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] }, - "name": { - "type": "string" + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] }, - "organizationId": { + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { "type": "string" }, - "organizationName": { + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { "type": "string" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" - }, - "type": "array" + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" }, - "telemetryConfig": { - "$ref": "#/components/schemas/TelemetryConfig" + "shadowSpread": { + "format": "double", + "type": "number" }, - "userId": { - "type": "string" + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "table": { + "$ref": "#/components/schemas/PublisherDocumentTableStyle" } }, - "required": [ - "entitlements", - "features", - "links", - "organizationId", - "organizationName", - "permissions", - "telemetryConfig", - "userId" - ], "type": "object" }, - "ProfileLinks": { + "PublisherDocumentVisualizationWidget": { + "description": "A saved visualization.", "properties": { - "organization": { + "altText": { + "description": "Defaults to the visualization's description.", "type": "string" }, - "self": { + "dateDataSet": { + "$ref": "#/components/schemas/PublisherDocumentDataSetRef" + }, + "display": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationDisplay" + }, + "filters": { + "description": "Widget filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "user": { + "ignoreDocumentFilters": { + "description": "Document filters this widget ignores.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilterReference" + }, + "type": "array" + }, + "ignoreDocumentPeriod": { + "type": "boolean" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationStyle" + }, + "title": { + "$ref": "#/components/schemas/PublisherDocumentWidgetTitle" + }, + "type": { + "enum": [ + "visualization" + ], "type": "string" + }, + "visualization": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationRef" } }, "required": [ - "organization", - "self", - "user" + "id", + "type" ], "type": "object" }, - "ProvisionDatabaseInstanceRequest": { - "description": "Request to provision a new AILake Database instance", + "PublisherDocumentWidgetPlaceholder": { + "description": "What the editor shows in an empty widget.", "properties": { - "dataSourceId": { - "description": "Identifier for the data source created in metadata-api. Defaults to the database name.", + "hint": { "type": "string" }, - "dataSourceName": { - "description": "Display name for the data source created in metadata-api. Defaults to the database name.", - "type": "string" + "required": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublisherDocumentWidgetTitle": { + "description": "Title of a visualization or takeaway widget.", + "properties": { + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextStyle" }, - "name": { - "description": "Name of the database instance", + "text": { + "description": "Overrides the default title; may contain text variables.", "type": "string" }, - "storageIds": { - "description": "Set of ids of the storage instances this database instance should access.", - "items": { - "description": "Set of ids of the storage instances this database instance should access.", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "visible": { + "description": "Default `true`.", + "type": "boolean" } }, - "required": [ - "name", - "storageIds" - ], "type": "object" }, "QualityIssue": { @@ -41091,6 +49237,68 @@ ], "type": "object" }, + "RelativePublisherDocumentPeriod": { + "allOf": [ + { + "properties": { + "from": { + "description": "Start of the period, in units relative to the current one.", + "example": -1, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Date granularity of the period.", + "enum": [ + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" + ], + "example": "GDC.time.month", + "type": "string" + }, + "to": { + "description": "End of the period, in units relative to the current one.", + "example": -1, + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Type of the period.", + "enum": [ + "relative" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A period counted in granularity units from the current one, which is 0.", + "properties": { + "type": { + "enum": [ + "relative" + ], + "type": "string" + } + }, + "required": [ + "from", + "granularity", + "to", + "type" + ], + "type": "object" + }, "RelativeWrapper": { "properties": { "relative": { @@ -41116,8 +49324,13 @@ "type": "object" }, "ReportExportRequest": { - "description": "Export request object describing the export properties and metadata for report exports.", + "description": "Export request object describing the export properties and metadata for document exports.", "properties": { + "documentId": { + "description": "Document identifier; the export renders the Publisher document page.", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, "fileName": { "description": "File name to be used for retrieving the pdf document.", "example": "filename", @@ -41135,7 +49348,8 @@ "$ref": "#/components/schemas/JsonNode" }, "reportId": { - "description": "Report identifier", + "deprecated": true, + "description": "Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, @@ -41148,8 +49362,7 @@ }, "required": [ "fileName", - "format", - "reportId" + "format" ], "type": "object" }, @@ -42780,7 +50993,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -44393,6 +52605,24 @@ ], "type": "object" }, + "WorkspaceLocalizationUsage": { + "properties": { + "settings": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "values": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageValue" + }, + "type": "array" + } + }, + "required": [ + "settings", + "values" + ], + "type": "object" + }, "WorkspacePermissionAssignment": { "description": "Workspace permission assignments", "properties": { @@ -45664,7 +53894,7 @@ }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv": { "post": { - "description": "Import the CSV files at the given locations in the staging area to the final location.", + "description": "Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file.", "operationId": "importCsv", "parameters": [ { @@ -45714,6 +53944,58 @@ } } }, + "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav": { + "post": { + "description": "Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file.", + "operationId": "importSav", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportSavRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ImportSavResponse" + }, + "type": "array" + } + } + }, + "description": "Successful import." + } + }, + "summary": "Import SPSS files", + "tags": [ + "Data source files import", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles": { "post": { "description": "List all the files in the given data source.", @@ -45850,6 +54132,48 @@ } } }, + "/api/v1/actions/fileStorage/staging/analyzeSav": { + "post": { + "description": "Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations.", + "operationId": "analyzeSav", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyzeSavRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponse" + }, + "type": "array" + } + } + }, + "description": "Successful analysis." + } + }, + "summary": "Analyze SPSS files", + "tags": [ + "Data source files analysis", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/fileStorage/staging/upload": { "post": { "description": "Provides a location for uploading staging files.", @@ -46371,6 +54695,282 @@ ] } }, + "/api/v1/actions/organization/localization/statistics": { + "get": { + "description": "(BETA) Lists the languages that have at least one translation, separately for each kind of translation.", + "operationId": "organizationLocalizationStatistics", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationStatistics" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages with translations in the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage": { + "get": { + "description": "(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", + "operationId": "organizationLocalizationUsage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsage" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages used in the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage/users": { + "get": { + "description": "(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed.", + "operationId": "organizationLocalizationUsageUsers", + "parameters": [ + { + "description": "Language tag that the user sets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "ito", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "USER", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageUsers" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Users who set a language themselves.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage/workspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.", + "operationId": "organizationLocalizationUsageWorkspaces", + "parameters": [ + { + "description": "Language tag that the workspace gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "PARENT", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces that use a language.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/organization/managePermissions": { "post": { "description": "Manage Permissions for a Organization", @@ -50225,6 +58825,209 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/export/document": { + "post": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId": "createDocumentExport", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportExportRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportResponse" + } + } + }, + "description": "Document export request created successfully." + } + }, + "summary": "(EXPERIMENTAL) Create document export request", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to execute document export.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}": { + "get": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId": "getDocumentExport", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Binary export result.", + "headers": { + "Content-Disposition": { + "schema": { + "example": "attachment; filename='result.pdf'", + "pattern": "attachment; filename='[^']+'", + "type": "string" + }, + "style": "simple" + } + } + }, + "202": { + "content": { + "application/pdf": { + "schema": { + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + } + }, + "description": "Request is accepted, provided exportId exists, but export is not yet ready." + } + }, + "summary": "(EXPERIMENTAL) Retrieve exported document", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata": { + "get": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.", + "operationId": "getDocumentExportMetadata", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": {} + }, + "description": "Json metadata representation" + } + }, + "summary": "(EXPERIMENTAL) Retrieve document export metadata", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/export/image": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", @@ -50572,7 +59375,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "deprecated": true, + "description": "Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", "operationId": "createReportExport", "parameters": [ { @@ -50630,7 +59434,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "deprecated": true, + "description": "Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", "operationId": "getReportExport", "parameters": [ { @@ -50732,7 +59537,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.", + "deprecated": true, + "description": "Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.", "operationId": "getReportExportMetadata", "parameters": [ { @@ -51649,6 +60455,201 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/localization/statistics": { + "get": { + "description": "(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.", + "operationId": "workspaceLocalizationStatistics", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationStatistics" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages with translations in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage": { + "get": { + "description": "(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.", + "operationId": "workspaceLocalizationUsage", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceLocalizationUsage" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages used in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage/users": { + "get": { + "description": "(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.", + "operationId": "workspaceLocalizationUsageUsers", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Language tag that the user gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "ito", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "WORKSPACE", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageUsers" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspace members who get a language.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { "post": { "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", @@ -59743,162 +68744,643 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "patch": { + "description": "User - represents entity interacting with platform", + "operationId": "patchEntity@Users", + "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": "authenticationId==someString;firstname==someString", + "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": "userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "User - represents entity interacting with platform", + "operationId": "updateEntity@Users", + "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": "authenticationId==someString;firstname==someString", + "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": "userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/users/{userId}/apiTokens": { + "get": { + "operationId": "getAllEntities@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "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": "bearerToken==someString", + "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/JsonApiApiTokenOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "List all api tokens for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + }, + "post": { + "operationId": "createEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post a new API token for the user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "delete": { + "operationId": "deleteEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete an API Token for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + }, + "get": { + "operationId": "getEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$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": "bearerToken==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get an API Token for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/customUserApplicationSettings": { + "get": { + "operationId": "getAllEntities@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "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": "applicationName==someString;content==JsonNodeValue", + "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/JsonApiCustomUserApplicationSettingOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "List all custom application settings for a user", + "tags": [ + "User Settings", + "entities", + "custom-user-application-setting-controller" + ] + }, + "post": { + "operationId": "createEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entity", + "summary": "Post a new custom application setting for the user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" + "custom-user-application-setting-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { + "delete": { + "operationId": "deleteEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/idPathParameter" + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a custom application setting for a user", + "tags": [ + "User Settings", + "entities", + "custom-user-application-setting-controller" + ] }, - "patch": { - "description": "User - represents entity interacting with platform", - "operationId": "patchEntity@Users", + "get": { + "operationId": "getEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$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": "authenticationId==someString;firstname==someString", + "example": "applicationName==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": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch User entity", + "summary": "Get a custom application setting for a user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "put": { - "description": "User - represents entity interacting with platform", - "operationId": "updateEntity@Users", + "operationId": "updateEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$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": "authenticationId==someString;firstname==someString", + "example": "applicationName==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": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } } }, @@ -59909,35 +69391,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put User entity", + "summary": "Put a custom application setting for the user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] } }, - "/api/v1/entities/users/{userId}/apiTokens": { + "/api/v1/entities/users/{userId}/userSettings": { "get": { - "operationId": "getAllEntities@ApiTokens", + "operationId": "getAllEntities@UserSettings", "parameters": [ { "in": "path", @@ -59949,7 +69425,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": "bearerToken==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -59993,27 +69469,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all api tokens for a user", + "summary": "List all settings for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] }, "post": { - "operationId": "createEntity@ApiTokens", + "operationId": "createEntity@UserSettings", "parameters": [ { "in": "path", @@ -60028,12 +69504,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -60044,29 +69520,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new API token for the user", + "summary": "Post new user settings for the user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] } }, - "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "/api/v1/entities/users/{userId}/userSettings/{id}": { "delete": { - "operationId": "deleteEntity@ApiTokens", + "operationId": "deleteEntity@UserSettings", "parameters": [ { "in": "path", @@ -60085,15 +69561,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an API Token for a user", + "summary": "Delete a setting for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] }, "get": { - "operationId": "getEntity@ApiTokens", + "operationId": "getEntity@UserSettings", "parameters": [ { "in": "path", @@ -60108,7 +69584,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": "bearerToken==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -60121,29 +69597,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an API Token for a user", + "summary": "Get a setting for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] - } - }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings": { - "get": { - "operationId": "getAllEntities@CustomUserApplicationSettings", + }, + "put": { + "operationId": "updateEntity@UserSettings", "parameters": [ { "in": "path", @@ -60153,15 +69627,93 @@ "type": "string" } }, + { + "$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/JsonApiUserSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put new user settings for the user", + "tags": [ + "User Settings", + "entities", + "user-setting-controller" + ] + } + }, + "/api/v1/entities/workspaces": { + "get": { + "description": "Space of the shared interest", + "operationId": "getAllEntities@Workspaces", + "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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -60173,7 +69725,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60182,6 +69734,10 @@ "description": "Included meta objects", "items": { "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", "page", "all", "ALL" @@ -60199,47 +69755,91 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all custom application settings for a user", + "summary": "Get Workspace entities", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "operationId": "createEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "createEntity@Workspaces", "parameters": [ { - "in": "path", - "name": "userId", - "required": true, + "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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -60250,136 +69850,280 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new custom application setting for the user", + "summary": "Post Workspace entities", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { + "/api/v1/entities/workspaces/{id}": { "delete": { - "operationId": "deleteEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "deleteEntity@Workspaces", "parameters": [ { - "in": "path", - "name": "userId", - "required": true, + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Workspace entity", + "tags": [ + "Workspaces - Entity APIs", + "entities", + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "description": "Space of the shared interest", + "operationId": "getEntity@Workspaces", + "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": "name==someString;earlyAccess==someString;parent.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { - "204": { - "$ref": "#/components/responses/Deleted" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Delete a custom application setting for a user", + "summary": "Get Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "get": { - "operationId": "getEntity@CustomUserApplicationSettings", + "patch": { + "description": "Space of the shared interest", + "operationId": "patchEntity@Workspaces", "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, { "$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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a custom application setting for a user", + "summary": "Patch Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { - "operationId": "updateEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "updateEntity@Workspaces", "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, { "$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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -60390,47 +70134,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a custom application setting for the user", + "summary": "Put Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/users/{userId}/userSettings": { + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { "get": { - "operationId": "getAllEntities@UserSettings", + "operationId": "getAllEntities@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.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": "dataset,sourceFact,sourceAttribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -60440,9 +70229,18 @@ { "$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", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60451,6 +70249,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -60468,127 +70267,194 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all settings for a user", + "summary": "Get all Aggregated Facts", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] - }, + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { "post": { - "operationId": "createEntity@UserSettings", + "operationId": "searchEntities@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "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/JsonApiUserSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post new user settings for the user", + "summary": "The search endpoint (beta)", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/entities/users/{userId}/userSettings/{id}": { - "delete": { - "operationId": "deleteEntity@UserSettings", + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "get": { + "operationId": "getEntity@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a setting for a user", - "tags": [ - "User Settings", - "entities", - "user-setting-controller" - ] - }, - "get": { - "operationId": "getEntity@UserSettings", - "parameters": [ { "in": "path", - "name": "userId", + "name": "objectId", "required": true, "schema": { "type": "string" } }, - { - "$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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.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": "dataset,sourceFact,sourceAttribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", + "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": { @@ -60596,97 +70462,62 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a setting for a user", + "summary": "Get an Aggregated Fact", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@UserSettings", + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "get": { + "operationId": "getAllEntities@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$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", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" - } - } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Put new user settings for the user", - "tags": [ - "User Settings", - "entities", - "user-setting-controller" - ] - } - }, - "/api/v1/entities/workspaces": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Workspaces", - "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;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -60695,7 +70526,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -60703,8 +70534,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -60722,9 +70564,18 @@ { "$ref": "#/components/parameters/sort" }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + "example": "metaInclude=permissions,origin,accessInfo,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60733,10 +70584,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "page", "all", "ALL" @@ -60754,23 +70604,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entities", + "summary": "Get all Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60780,12 +70630,19 @@ } }, "post": { - "description": "Space of the shared interest", - "operationId": "createEntity@Workspaces", + "operationId": "createEntity@AnalyticalDashboards", "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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -60793,8 +70650,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -60805,7 +70673,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60814,10 +70682,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "all", "ALL" ], @@ -60833,12 +70700,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } } }, @@ -60849,39 +70716,130 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace entities", + "summary": "Post Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "post": { + "operationId": "searchEntities@AnalyticalDashboards", + "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/JsonApiAnalyticalDashboardOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Dashboards", + "entities", + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { "delete": { - "description": "Space of the shared interest", - "operationId": "deleteEntity@Workspaces", + "operationId": "deleteEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -60889,29 +70847,41 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Workspace entity", + "summary": "Delete a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Workspaces", + "operationId": "getEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -60920,7 +70890,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -60928,8 +70898,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -60938,9 +70919,18 @@ }, "style": "form" }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60949,10 +70939,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "all", "ALL" ], @@ -60969,23 +70958,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entity", + "summary": "Get a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60995,15 +70984,27 @@ } }, "patch": { - "description": "Space of the shared interest", - "operationId": "patchEntity@Workspaces", + "operationId": "patchEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -61012,7 +71013,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -61020,8 +71021,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -61035,12 +71047,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, @@ -61051,41 +71063,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Workspace entity", + "summary": "Patch a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "description": "Space of the shared interest", - "operationId": "updateEntity@Workspaces", + "operationId": "updateEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -61094,7 +71118,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -61102,8 +71126,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -61117,12 +71152,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } } }, @@ -61133,35 +71168,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Workspace entity", + "summary": "Put Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { "get": { - "operationId": "getAllEntities@AggregatedFacts", + "operationId": "getAllEntities@AttributeHierarchies", "parameters": [ { "in": "path", @@ -61188,7 +71223,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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -61197,7 +71232,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": "dataset,sourceFact,sourceAttribute", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -61205,12 +71240,10 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "userIdentifiers", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -61266,23 +71299,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Aggregated Facts", + "summary": "Get all Attribute Hierarchies", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61290,11 +71323,112 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@AttributeHierarchies", + "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,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "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/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Attribute Hierarchies", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { "post": { - "operationId": "searchEntities@AggregatedFacts", + "operationId": "searchEntities@AttributeHierarchies", "parameters": [ { "in": "path", @@ -61345,12 +71479,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, @@ -61359,9 +71493,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61371,9 +71505,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "delete": { + "operationId": "deleteEntity@AttributeHierarchies", + "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 an Attribute Hierarchy", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@AggregatedFacts", + "operationId": "getEntity@AttributeHierarchies", "parameters": [ { "in": "path", @@ -61393,7 +71565,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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -61402,7 +71574,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": "dataset,sourceFact,sourceAttribute", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -61410,12 +71582,10 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "userIdentifiers", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -61461,23 +71631,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Aggregated Fact", + "summary": "Get an Attribute Hierarchy", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61485,11 +71655,9 @@ "VIEW" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { - "get": { - "operationId": "getAllEntities@AnalyticalDashboards", + }, + "patch": { + "operationId": "patchEntity@AttributeHierarchies", "parameters": [ { "in": "path", @@ -61500,17 +71668,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" } }, @@ -61525,7 +71686,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -61534,18 +71695,9 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", - "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", + "attributes", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -61553,83 +71705,153 @@ "type": "array" }, "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + } + } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch an Attribute Hierarchy", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@AttributeHierarchies", + "parameters": [ { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/sort" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } }, { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, + "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": { - "default": false, - "type": "boolean" + "type": "string" } }, { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,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,attributes", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "permissions", - "origin", - "accessInfo", - "page", - "all", + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Dashboards", + "summary": "Put an Attribute Hierarchy", "tags": [ - "Dashboards", + "Attribute Hierarchies", "entities", - "analytical-dashboard-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "ANALYZE" ] } - }, - "post": { - "operationId": "createEntity@AnalyticalDashboards", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "get": { + "operationId": "getAllEntities@Attributes", "parameters": [ { "in": "path", @@ -61639,9 +71861,33 @@ "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;dataset.id==321;defaultView.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,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -61649,19 +71895,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -61670,9 +71908,27 @@ }, "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=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -61683,7 +71939,7 @@ "enum": [ "permissions", "origin", - "accessInfo", + "page", "all", "ALL" ], @@ -61695,55 +71951,40 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Dashboards", + "summary": "Get all Attributes", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-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": [ - "ANALYZE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { "post": { - "operationId": "searchEntities@AnalyticalDashboards", + "operationId": "searchEntities@Attributes", "parameters": [ { "in": "path", @@ -61794,12 +72035,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, @@ -61808,9 +72049,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61820,47 +72061,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { - "delete": { - "operationId": "deleteEntity@AnalyticalDashboards", - "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 Dashboard", - "tags": [ - "Dashboards", - "entities", - "analytical-dashboard-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { "get": { - "operationId": "getEntity@AnalyticalDashboards", + "operationId": "getEntity@Attributes", "parameters": [ { "in": "path", @@ -61880,7 +72083,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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -61889,7 +72092,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -61897,19 +72100,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -61929,7 +72124,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -61940,7 +72135,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -61957,23 +72151,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dashboard", + "summary": "Get an Attribute", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61983,7 +72177,7 @@ } }, "patch": { - "operationId": "patchEntity@AnalyticalDashboards", + "operationId": "patchEntity@Attributes", "parameters": [ { "in": "path", @@ -62003,7 +72197,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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -62012,7 +72206,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -62020,19 +72214,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -62046,12 +72232,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } } }, @@ -62062,33 +72248,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dashboard", + "summary": "Patch an Attribute (beta)", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@AnalyticalDashboards", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { + "post": { + "operationId": "searchEntities@AutomationResults", "parameters": [ { "in": "path", @@ -62099,67 +72287,39 @@ } }, { - "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;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "filter", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "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,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", - "explode": false, - "in": "query", - "name": "include", + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", - "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -62167,35 +72327,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put Dashboards", + "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Automations", "entities", - "analytical-dashboard-controller" + "automation-result-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": [ - "ANALYZE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { + "/api/v1/entities/workspaces/{workspaceId}/automations": { "get": { - "operationId": "getAllEntities@AttributeHierarchies", + "operationId": "getAllEntities@Automations", "parameters": [ { "in": "path", @@ -62222,7 +72382,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -62231,7 +72391,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -62239,10 +72399,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -62298,23 +72471,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attribute Hierarchies", + "summary": "Get all Automations", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62324,7 +72497,7 @@ } }, "post": { - "operationId": "createEntity@AttributeHierarchies", + "operationId": "createEntity@Automations", "parameters": [ { "in": "path", @@ -62336,7 +72509,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -62344,10 +72517,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -62383,12 +72569,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, @@ -62399,35 +72585,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Attribute Hierarchies", + "summary": "Post Automations", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { + "/api/v1/entities/workspaces/{workspaceId}/automations/search": { "post": { - "operationId": "searchEntities@AttributeHierarchies", + "operationId": "searchEntities@Automations", "parameters": [ { "in": "path", @@ -62478,12 +72664,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, @@ -62492,9 +72678,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62504,9 +72690,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { "delete": { - "operationId": "deleteEntity@AttributeHierarchies", + "operationId": "deleteEntity@Automations", "parameters": [ { "in": "path", @@ -62530,21 +72716,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Attribute Hierarchy", + "summary": "Delete an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } }, "get": { - "operationId": "getEntity@AttributeHierarchies", + "operationId": "getEntity@Automations", "parameters": [ { "in": "path", @@ -62564,7 +72750,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -62573,7 +72759,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -62581,10 +72767,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -62630,23 +72829,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute Hierarchy", + "summary": "Get an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62656,7 +72855,7 @@ } }, "patch": { - "operationId": "patchEntity@AttributeHierarchies", + "operationId": "patchEntity@Automations", "parameters": [ { "in": "path", @@ -62676,7 +72875,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -62685,7 +72884,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -62693,10 +72892,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -62710,12 +72922,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } } }, @@ -62726,33 +72938,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute Hierarchy", + "summary": "Patch an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } }, "put": { - "operationId": "updateEntity@AttributeHierarchies", + "operationId": "updateEntity@Automations", "parameters": [ { "in": "path", @@ -62772,7 +72984,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -62781,7 +72993,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -62789,10 +73001,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -62806,12 +73031,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, @@ -62822,35 +73047,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Attribute Hierarchy", + "summary": "Put an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { "get": { - "operationId": "getAllEntities@Attributes", + "operationId": "getAllEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -62877,7 +73102,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62886,7 +73111,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -62894,11 +73119,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -62955,23 +73186,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attributes", + "summary": "Get all Computed Attributes", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62979,11 +73210,120 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@ComputedAttributes", + "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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Computed Attributes", + "tags": [ + "Computed Attributes", + "entities", + "computed-attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to create Computed Attributes", + "permissions": [ + "CREATE_COMPUTED_ATTRIBUTE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { "post": { - "operationId": "searchEntities@Attributes", + "operationId": "searchEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -63018,51 +73358,89 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, + "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/JsonApiComputedAttributeOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Computed Attributes", + "entities", + "computed-attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { + "delete": { + "operationId": "deleteEntity@ComputedAttributes", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - } - }, - "description": "Request successfully processed" + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "The search endpoint (beta)", + "summary": "Delete a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { + }, "get": { - "operationId": "getEntity@Attributes", + "operationId": "getEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -63082,7 +73460,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63091,7 +73469,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -63099,11 +73477,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -63150,23 +73534,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute", + "summary": "Get a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63176,7 +73560,7 @@ } }, "patch": { - "operationId": "patchEntity@Attributes", + "operationId": "patchEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -63196,7 +73580,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63205,7 +73589,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -63213,11 +73597,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -63231,12 +73621,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } } }, @@ -63247,23 +73637,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -63271,11 +73661,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { - "post": { - "operationId": "searchEntities@AutomationResults", + }, + "put": { + "operationId": "updateEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -63286,39 +73674,65 @@ } }, { + "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;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "origin", - "required": false, + "name": "filter", "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", + "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,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -63326,35 +73740,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Put a Computed Attribute", "tags": [ - "Automations", + "Computed Attributes", "entities", - "automation-result-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { "get": { - "operationId": "getAllEntities@Automations", + "operationId": "getAllEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63381,48 +73795,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -63470,23 +73849,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations", + "summary": "Get all Custom Application Settings", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63496,7 +73875,7 @@ } }, "post": { - "operationId": "createEntity@Automations", + "operationId": "createEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63506,41 +73885,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -63568,12 +73912,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, @@ -63584,35 +73928,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Automations", + "summary": "Post Custom Application Settings", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/search": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { "post": { - "operationId": "searchEntities@Automations", + "operationId": "searchEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63663,12 +74001,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, @@ -63677,9 +74015,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63689,9 +74027,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@Automations", + "operationId": "deleteEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63715,21 +74053,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Automation", + "summary": "Delete a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@Automations", + "operationId": "getEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63749,48 +74081,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -63828,23 +74125,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Automation", + "summary": "Get a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63854,7 +74151,7 @@ } }, "patch": { - "operationId": "patchEntity@Automations", + "operationId": "patchEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63874,59 +74171,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, @@ -63937,33 +74199,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Automation", + "summary": "Patch a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@Automations", + "operationId": "updateEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -63983,59 +74239,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, @@ -64046,35 +74267,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Automation", + "summary": "Put a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { "get": { - "operationId": "getAllEntities@ComputedAttributes", + "operationId": "getAllEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -64110,7 +74325,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64119,16 +74334,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64157,7 +74364,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,page,all", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -64166,7 +74373,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "page", "all", @@ -64185,23 +74391,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Computed Attributes", + "summary": "Get all Plugins", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64211,7 +74417,7 @@ } }, "post": { - "operationId": "createEntity@ComputedAttributes", + "operationId": "createEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -64223,7 +74429,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64232,16 +74438,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64252,7 +74450,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -64261,7 +74459,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -64278,12 +74475,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } } }, @@ -64294,35 +74491,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Computed Attributes", + "summary": "Post Plugins", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to create Computed Attributes", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_COMPUTED_ATTRIBUTE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { "post": { - "operationId": "searchEntities@ComputedAttributes", + "operationId": "searchEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -64373,12 +74570,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, @@ -64387,9 +74584,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64399,9 +74596,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { "delete": { - "operationId": "deleteEntity@ComputedAttributes", + "operationId": "deleteEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -64425,21 +74622,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Computed Attribute", + "summary": "Delete a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "operationId": "getEntity@ComputedAttributes", + "operationId": "getEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -64468,7 +74665,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64477,16 +74674,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64506,7 +74695,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -64515,7 +74704,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -64533,23 +74721,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Computed Attribute", + "summary": "Get a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64559,7 +74747,7 @@ } }, "patch": { - "operationId": "patchEntity@ComputedAttributes", + "operationId": "patchEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -64588,7 +74776,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64597,16 +74785,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64620,12 +74800,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, @@ -64636,33 +74816,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Computed Attribute", + "summary": "Patch a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "operationId": "updateEntity@ComputedAttributes", + "operationId": "updateEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -64691,7 +74871,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64700,16 +74880,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64723,12 +74895,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, @@ -64739,35 +74911,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Computed Attribute", + "summary": "Put a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { + "/api/v1/entities/workspaces/{workspaceId}/datasets": { "get": { - "operationId": "getAllEntities@CustomApplicationSettings", + "operationId": "getAllEntities@Datasets", "parameters": [ { "in": "path", @@ -64794,13 +74966,37 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -64848,23 +75044,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Application Settings", + "summary": "Get all Datasets", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64872,84 +75068,11 @@ "VIEW" ] } - }, - "post": { - "operationId": "createEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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/JsonApiCustomApplicationSettingPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Custom Application Settings", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { + "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { "post": { - "operationId": "searchEntities@CustomApplicationSettings", + "operationId": "searchEntities@Datasets", "parameters": [ { "in": "path", @@ -65000,12 +75123,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, @@ -65014,9 +75137,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65026,41 +75149,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { - "delete": { - "operationId": "deleteEntity@CustomApplicationSettings", - "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 Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] - }, + "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { "get": { - "operationId": "getEntity@CustomApplicationSettings", + "operationId": "getEntity@Datasets", "parameters": [ { "in": "path", @@ -65080,13 +75171,37 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -65124,23 +75239,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Custom Application Setting", + "summary": "Get a Dataset", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65150,7 +75265,7 @@ } }, "patch": { - "operationId": "patchEntity@CustomApplicationSettings", + "operationId": "patchEntity@Datasets", "parameters": [ { "in": "path", @@ -65170,92 +75285,48 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@CustomApplicationSettings", - "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": "applicationName==someString;content==JsonNodeValue", + "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, "in": "query", - "name": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } } }, @@ -65266,29 +75337,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Custom Application Setting", + "summary": "Patch a Dataset (beta)", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { + "/api/v1/entities/workspaces/{workspaceId}/documentTemplates": { "get": { - "operationId": "getAllEntities@DashboardPlugins", + "operationId": "getAllEntities@DocumentTemplates", "parameters": [ { "in": "path", @@ -65315,7 +75392,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -65390,23 +75467,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Plugins", + "summary": "Get all Document Templates", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65416,7 +75493,7 @@ } }, "post": { - "operationId": "createEntity@DashboardPlugins", + "operationId": "createEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -65474,12 +75551,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalIdDocument" } } }, @@ -65490,114 +75567,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Plugins", + "summary": "Post Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { - "post": { - "operationId": "searchEntities@DashboardPlugins", - "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/JsonApiDashboardPluginOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@DashboardPlugins", + "operationId": "deleteEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -65621,21 +75619,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Plugin", + "summary": "Delete a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@DashboardPlugins", + "operationId": "getEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -65655,7 +75653,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -65720,23 +75718,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Plugin", + "summary": "Get a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65746,7 +75744,7 @@ } }, "patch": { - "operationId": "patchEntity@DashboardPlugins", + "operationId": "patchEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -65766,7 +75764,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -65799,12 +75797,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatchDocument" } } }, @@ -65815,33 +75813,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Plugin", + "summary": "Patch a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@DashboardPlugins", + "operationId": "updateEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -65861,7 +75859,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -65894,12 +75892,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateInDocument" } } }, @@ -65910,35 +75908,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Plugin", + "summary": "Put a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets": { + "/api/v1/entities/workspaces/{workspaceId}/documents": { "get": { - "operationId": "getAllEntities@Datasets", + "operationId": "getAllEntities@Documents", "parameters": [ { "in": "path", @@ -65965,7 +75963,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -65974,7 +75972,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -65982,12 +75980,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -66043,23 +76038,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Datasets", + "summary": "Get all Documents", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -66067,11 +76062,9 @@ "VIEW" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { + }, "post": { - "operationId": "searchEntities@Datasets", + "operationId": "createEntity@Documents", "parameters": [ { "in": "path", @@ -66082,75 +76075,136 @@ } }, { + "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": "origin", + "name": "include", "required": false, "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "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/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}": { + "delete": { + "operationId": "deleteEntity@Documents", + "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 Document", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Datasets", + "operationId": "getEntity@Documents", "parameters": [ { "in": "path", @@ -66170,7 +76224,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -66179,7 +76233,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -66187,12 +76241,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -66238,23 +76289,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dataset", + "summary": "Get a Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -66264,7 +76315,7 @@ } }, "patch": { - "operationId": "patchEntity@Datasets", + "operationId": "patchEntity@Documents", "parameters": [ { "in": "path", @@ -66284,7 +76335,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -66293,7 +76344,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -66301,12 +76352,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -66320,12 +76368,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatchDocument" } } }, @@ -66336,23 +76384,118 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Patch a Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Documents", + "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": "version==someString;title==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/JsonApiPublisherDocumentInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Document", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -70809,48 +80952,493 @@ "type": "array" }, "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Metrics", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to create Metrics", + "permissions": [ + "CREATE_METRIC" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { + "post": { + "operationId": "searchEntities@Metrics", + "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/JsonApiMetricOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "delete": { + "operationId": "deleteEntity@Metrics", + "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 Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "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=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { @@ -70866,23 +81454,23 @@ "description": "Request successfully processed" } }, - "summary": "Post Metrics", + "summary": "Put a Metric", "tags": [ "Metrics", "entities", "metric-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to create Metrics", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_METRIC" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { - "post": { - "operationId": "searchEntities@Metrics", + "/api/v1/entities/workspaces/{workspaceId}/pageTemplates": { + "get": { + "operationId": "getAllEntities@PageTemplates", "parameters": [ { "in": "path", @@ -70907,6 +81495,45 @@ "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": "version==someString;title==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", @@ -70915,53 +81542,165 @@ "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/JsonApiPublisherDocumentPageTemplateOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Page Templates", + "tags": [ + "Publisher Documents", + "entities", + "page-template-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@PageTemplates", + "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/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@PageTemplates", "parameters": [ { "in": "path", @@ -70985,11 +81724,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -70999,7 +81738,7 @@ } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@PageTemplates", "parameters": [ { "in": "path", @@ -71019,7 +81758,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -71028,7 +81767,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -71037,16 +81776,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -71066,7 +81797,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -71075,7 +81806,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -71093,23 +81823,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -71119,7 +81849,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@PageTemplates", "parameters": [ { "in": "path", @@ -71139,7 +81869,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -71148,7 +81878,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -71157,16 +81887,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -71180,12 +81902,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatchDocument" } } }, @@ -71196,23 +81918,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -71222,7 +81944,7 @@ } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@PageTemplates", "parameters": [ { "in": "path", @@ -71242,7 +81964,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -71251,7 +81973,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -71260,16 +81982,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -71283,12 +81997,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateInDocument" } } }, @@ -71299,23 +82013,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index f118620ce..5e45a8462 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -2716,6 +2716,9 @@ "reportPageLayout", "reportTemplate", "report", + "pageTemplate", + "document", + "documentTemplate", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index b6016cc69..4d05c21f5 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -103,7 +103,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -2029,6 +2029,9 @@ "reportPageLayout", "reportTemplate", "report", + "pageTemplate", + "document", + "documentTemplate", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -2982,8 +2985,13 @@ "type": "object" }, "ReportExportRequest": { - "description": "Export request object describing the export properties and metadata for report exports.", + "description": "Export request object describing the export properties and metadata for document exports.", "properties": { + "documentId": { + "description": "Document identifier; the export renders the Publisher document page.", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, "fileName": { "description": "File name to be used for retrieving the pdf document.", "example": "filename", @@ -3001,7 +3009,8 @@ "$ref": "#/components/schemas/JsonNode" }, "reportId": { - "description": "Report identifier", + "deprecated": true, + "description": "Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, @@ -3014,8 +3023,7 @@ }, "required": [ "fileName", - "format", - "reportId" + "format" ], "type": "object" }, @@ -3425,6 +3433,209 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/export/document": { + "post": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId": "createDocumentExport", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportExportRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportResponse" + } + } + }, + "description": "Document export request created successfully." + } + }, + "summary": "(EXPERIMENTAL) Create document export request", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to execute document export.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}": { + "get": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId": "getDocumentExport", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Binary export result.", + "headers": { + "Content-Disposition": { + "schema": { + "example": "attachment; filename='result.pdf'", + "pattern": "attachment; filename='[^']+'", + "type": "string" + }, + "style": "simple" + } + } + }, + "202": { + "content": { + "application/pdf": { + "schema": { + "items": { + "properties": { + "char": { + "type": "string" + }, + "direct": { + "type": "boolean" + }, + "double": { + "format": "double", + "type": "number" + }, + "float": { + "format": "float", + "type": "number" + }, + "int": { + "format": "int32", + "type": "integer" + }, + "long": { + "format": "int64", + "type": "integer" + }, + "readOnly": { + "type": "boolean" + }, + "short": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + } + }, + "description": "Request is accepted, provided exportId exists, but export is not yet ready." + } + }, + "summary": "(EXPERIMENTAL) Retrieve exported document", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata": { + "get": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.", + "operationId": "getDocumentExportMetadata", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": {} + }, + "description": "Json metadata representation" + } + }, + "summary": "(EXPERIMENTAL) Retrieve document export metadata", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/export/image": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", @@ -3772,7 +3983,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "deprecated": true, + "description": "Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", "operationId": "createReportExport", "parameters": [ { @@ -3830,7 +4042,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "deprecated": true, + "description": "Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", "operationId": "getReportExport", "parameters": [ { @@ -3932,7 +4145,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata": { "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.", + "deprecated": true, + "description": "Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.", "operationId": "getReportExportMetadata", "parameters": [ { diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 6b3ec2a7d..0336e3246 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -148,7 +148,7 @@ "type": "object" }, "AbsoluteGranularityDateFilter": { - "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", + "description": "An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.", "properties": { "absoluteGranularityDateFilter": { "properties": { @@ -243,6 +243,58 @@ ], "type": "object" }, + "AbsolutePublisherDocumentPeriod": { + "allOf": [ + { + "properties": { + "from": { + "description": "First day of the period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "granularity": { + "description": "Date granularity of the period.", + "enum": [ + "GDC.time.date" + ], + "example": "GDC.time.date", + "type": "string" + }, + "to": { + "description": "Last day of the period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "type": { + "description": "Type of the period.", + "enum": [ + "absolute" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A period between two dates.", + "properties": { + "type": { + "enum": [ + "absolute" + ], + "type": "string" + } + }, + "required": [ + "from", + "granularity", + "to", + "type" + ], + "type": "object" + }, "AbstractMeasureValueFilter": { "oneOf": [ { @@ -3465,7 +3517,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -3679,7 +3732,7 @@ "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "permissions": { - "description": "A list of permissions.", + "description": "A list of permissions. A PUT without this property removes all existing permissions.", "items": { "oneOf": [ { @@ -3883,6 +3936,20 @@ }, "type": "array" }, + "documentTemplates": { + "description": "A list of document templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocumentTemplate" + }, + "type": "array" + }, + "documents": { + "description": "A list of documents available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocument" + }, + "type": "array" + }, "exportDefinitions": { "description": "A list of export definitions.", "items": { @@ -3911,6 +3978,13 @@ }, "type": "array" }, + "pageTemplates": { + "description": "A list of page templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativePublisherDocumentPageTemplate" + }, + "type": "array" + }, "parameters": { "description": "A list of parameters available in the model.", "items": { @@ -4353,6 +4427,12 @@ "example": "INT", "type": "string" }, + "defaultLabelOf": { + "description": "(EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.", + "example": "gender", + "maxLength": 255, + "type": "string" + }, "description": { "description": "Column description/comment from database", "example": "Customer unique identifier", @@ -4785,6 +4865,11 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "name": { "description": "Name of the data source.", "example": "postgres demo", @@ -4859,7 +4944,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -6008,6 +6092,21 @@ "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "permissions": { + "description": "A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionForAssigneeRule" + } + ] + }, + "nullable": true, + "type": "array" + }, "tags": { "description": "A list of tags.", "example": [ @@ -6035,6 +6134,67 @@ ], "type": "object" }, + "DeclarativeMetricPermissionAssignment": { + "description": "Metric permission.", + "nullable": true, + "properties": { + "name": { + "description": "Permission name.", + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "DeclarativeMetricPermissionForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionAssignment" + }, + { + "properties": { + "assignee": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Metric permission for an assignee.", + "required": [ + "assignee", + "name" + ], + "type": "object" + }, + "DeclarativeMetricPermissionForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeMetricPermissionAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Metric permission for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "name" + ], + "type": "object" + }, "DeclarativeModel": { "description": "A data model structured as a set of its attributes.", "properties": { @@ -6421,6 +6581,142 @@ ], "type": "object" }, + "DeclarativePublisherDocument": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentContent" + }, + "description": { + "description": "Document description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Document ID.", + "example": "levis-h1-2026", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "period": { + "$ref": "#/components/schemas/PublisherDocumentPeriod" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Document title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "period", + "title", + "version" + ], + "type": "object" + }, + "DeclarativePublisherDocumentPageTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentPageTemplateContent" + }, + "description": { + "description": "Page template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Page template ID.", + "example": "brand-cover", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Page template title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "title", + "version" + ], + "type": "object" + }, + "DeclarativePublisherDocumentTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/PublisherDocumentContent" + }, + "description": { + "description": "Document template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Document template ID.", + "example": "brand-review", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "tags": { + "items": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Document template title.", + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "id", + "title", + "version" + ], + "type": "object" + }, "DeclarativeReference": { "description": "A dataset reference.", "properties": { @@ -6896,6 +7192,13 @@ }, "type": "array" }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.", + "type": "object" + }, "type": { "description": "Table type: TABLE or VIEW.", "example": "TABLE", @@ -7333,6 +7636,21 @@ "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "permissions": { + "description": "A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssignee" + }, + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionForAssigneeRule" + } + ] + }, + "nullable": true, + "type": "array" + }, "tags": { "description": "A list of tags.", "example": [ @@ -7360,6 +7678,67 @@ ], "type": "object" }, + "DeclarativeVisualizationObjectPermissionAssignment": { + "description": "Visualization object permission.", + "nullable": true, + "properties": { + "name": { + "description": "Permission name.", + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "DeclarativeVisualizationObjectPermissionForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionAssignment" + }, + { + "properties": { + "assignee": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Visualization object permission for an assignee.", + "required": [ + "assignee", + "name" + ], + "type": "object" + }, + "DeclarativeVisualizationObjectPermissionForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DeclarativeVisualizationObjectPermissionAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Visualization object permission for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "name" + ], + "type": "object" + }, "DeclarativeWorkspace": { "description": "A declarative form of a particular workspace.", "properties": { @@ -8783,6 +9162,9 @@ "reportPageLayout", "reportTemplate", "report", + "pageTemplate", + "document", + "documentTemplate", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -9072,7 +9454,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -9229,7 +9612,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -9495,7 +9879,8 @@ "knowledge", "dashboard_builder", "dashboard_editor", - "report_builder" + "report_builder", + "document_builder" ], "type": "string" }, @@ -15477,7 +15862,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -15656,6 +16040,11 @@ "nullable": true, "type": "boolean" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -15736,7 +16125,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -15885,6 +16273,11 @@ "nullable": true, "type": "boolean" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "managed": { "description": "Whether the object is platform-managed and read-only.", "type": "boolean" @@ -15945,7 +16338,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -16136,6 +16528,11 @@ "nullable": true, "type": "boolean" }, + "ignoreJwtAud": { + "description": "Turns off the check that the audience of an OIDC access token names the host of the data source, for the OIDC_PASSTHROUGH authentication type. Only an organization administrator may set it.", + "nullable": true, + "type": "boolean" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -16216,7 +16613,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO", @@ -25144,8 +25540,8 @@ }, "type": "array" }, - "JsonApiReportIn": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentIn": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -25153,263 +25549,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -25417,17 +25741,24 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -25439,18 +25770,17 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -25463,9 +25793,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -25476,10 +25806,10 @@ ], "type": "object" }, - "JsonApiReportInDocument": { + "JsonApiPublisherDocumentInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentIn" } }, "required": [ @@ -25487,8 +25817,8 @@ ], "type": "object" }, - "JsonApiReportOut": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentOut": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -25496,263 +25826,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -25776,17 +26034,24 @@ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -25798,18 +26063,17 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -25875,9 +26139,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -25888,10 +26152,10 @@ ], "type": "object" }, - "JsonApiReportOutDocument": { + "JsonApiPublisherDocumentOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOut" }, "included": { "description": "Included resources", @@ -25923,12 +26187,12 @@ ], "type": "object" }, - "JsonApiReportOutList": { + "JsonApiPublisherDocumentOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutWithLinks" }, "type": "array", "uniqueItems": true @@ -25966,18 +26230,18 @@ ], "type": "object" }, - "JsonApiReportOutWithLinks": { + "JsonApiPublisherDocumentOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportPageLayoutIn": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplateIn": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -25985,132 +26249,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -26126,11 +26394,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -26143,9 +26417,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -26156,10 +26430,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutInDocument": { + "JsonApiPublisherDocumentPageTemplateInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateIn" } }, "required": [ @@ -26167,8 +26441,8 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOut": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplateOut": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -26176,132 +26450,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "createdAt": { @@ -26333,11 +26611,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -26403,9 +26687,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -26416,10 +26700,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutDocument": { + "JsonApiPublisherDocumentPageTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOut" }, "included": { "description": "Included resources", @@ -26451,12 +26735,12 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutList": { + "JsonApiPublisherDocumentPageTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -26494,18 +26778,18 @@ ], "type": "object" }, - "JsonApiReportPageLayoutOutWithLinks": { + "JsonApiPublisherDocumentPageTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportPageLayoutPatch": { - "description": "JSON:API representation of patching reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplatePatch": { + "description": "JSON:API representation of patching pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -26513,132 +26797,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -26654,6 +26942,11 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "type": "object" @@ -26667,9 +26960,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -26680,10 +26973,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPatchDocument": { + "JsonApiPublisherDocumentPageTemplatePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatch" } }, "required": [ @@ -26691,8 +26984,8 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPostOptionalId": { - "description": "JSON:API representation of reportPageLayout entity.", + "JsonApiPublisherDocumentPageTemplatePostOptionalId": { + "description": "JSON:API representation of pageTemplate entity.", "properties": { "attributes": { "properties": { @@ -26700,132 +26993,136 @@ "type": "boolean" }, "content": { - "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "One page without `id` and `visible`, validated on write. An invalid value is a 400 whose `path` names the first invalid key, such as `content.layout.type`. Maximum supported length is 250000 characters.", "example": { - "format": "widescreen", "kind": "content", "layout": { "children": [ { - "slotId": "pageTitle", - "type": "slotRef", - "weight": 2 + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" }, { "children": [ { "children": [ { - "slotId": "widget1", - "type": "slotRef" + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" }, { - "slotId": "widget2", - "type": "slotRef" + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" } ], - "direction": "row", - "type": "section", - "weight": 2 + "proportion": 2, + "type": "row" }, { - "slotId": "summary", - "type": "slotRef", - "weight": 1 + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 9 + "proportion": 9, + "type": "row" }, { "children": [ { - "slotId": "footerLogo", - "type": "slotRef", - "weight": 1 + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" }, { - "slotId": "footerPageNumber", - "type": "slotRef", - "weight": 8 + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 1, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "slots": [ - { - "localIdentifier": "pageTitle", - "placeholder": { - "hint": "Page title" - }, - "style": { - "type": "h1" - }, - "type": "heading" + "type": "column" + } + }, + "properties": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" }, - { - "localIdentifier": "widget1", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "widget2", - "placeholder": { - "hint": "Add a visualization" - }, - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ], - "version": "1" + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + } }, + "required": [ + "layout" + ], "type": "object" }, "description": { @@ -26841,11 +27138,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -26858,9 +27161,9 @@ "type": { "description": "Object type", "enum": [ - "reportPageLayout" + "pageTemplate" ], - "example": "reportPageLayout", + "example": "pageTemplate", "type": "string" } }, @@ -26870,10 +27173,10 @@ ], "type": "object" }, - "JsonApiReportPageLayoutPostOptionalIdDocument": { + "JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalId" } }, "required": [ @@ -26881,8 +27184,8 @@ ], "type": "object" }, - "JsonApiReportPatch": { - "description": "JSON:API representation of patching report entity.", + "JsonApiPublisherDocumentPatch": { + "description": "JSON:API representation of patching document entity.", "properties": { "attributes": { "properties": { @@ -26890,263 +27193,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -27154,17 +27385,24 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -27176,11 +27414,10 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "type": "object" @@ -27194,9 +27431,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -27207,10 +27444,10 @@ ], "type": "object" }, - "JsonApiReportPatchDocument": { + "JsonApiPublisherDocumentPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPatch" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatch" } }, "required": [ @@ -27218,8 +27455,8 @@ ], "type": "object" }, - "JsonApiReportPostOptionalId": { - "description": "JSON:API representation of report entity.", + "JsonApiPublisherDocumentPostOptionalId": { + "description": "JSON:API representation of document entity.", "properties": { "attributes": { "properties": { @@ -27227,263 +27464,191 @@ "type": "boolean" }, "content": { - "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, "filters": [ { "attributeFilter": { "attributeElements": { - "uris": [ - "EMEA" - ] + "uris": [] }, "displayForm": { - "identifier": "region.name", + "identifier": "brand.name", "type": "displayForm" }, - "localIdentifier": "report_filter_region", - "negativeSelection": false, - "title": "Region" + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" } } ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "source": { - "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", - "type": "static" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -27491,17 +27656,24 @@ "maxLength": 10000, "type": "string" }, - "periodEnd": { - "description": "Last day of the reported period, inclusive.", - "example": "2026-06-30", - "format": "date", - "type": "string" - }, - "periodStart": { - "description": "First day of the reported period, inclusive.", - "example": "2026-01-01", - "format": "date", - "type": "string" + "period": { + "description": "The period the document covers, absolute or relative to today.", + "discriminator": { + "mapping": { + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" + }, + { + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" + } + ], + "type": "object" }, "tags": { "items": { @@ -27513,18 +27685,17 @@ "maxLength": 255, "type": "string" }, - "variableValues": { - "description": "Values for the variables declared in the content, keyed by name.", - "example": { - "regionName": "EMEA" - } + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "periodEnd", - "periodStart", - "title" + "period", + "title", + "version" ], "type": "object" }, @@ -27537,9 +27708,9 @@ "type": { "description": "Object type", "enum": [ - "report" + "document" ], - "example": "report", + "example": "document", "type": "string" } }, @@ -27549,10 +27720,10 @@ ], "type": "object" }, - "JsonApiReportPostOptionalIdDocument": { + "JsonApiPublisherDocumentPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportPostOptionalId" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalId" } }, "required": [ @@ -27560,8 +27731,8 @@ ], "type": "object" }, - "JsonApiReportTemplateIn": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiPublisherDocumentTemplateIn": { + "description": "JSON:API representation of documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -27569,244 +27740,191 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 - }, - { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "children": [ - { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" } ], - "direction": "column", - "type": "section" + "type": "column" }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } }, { - "format": "widescreen", + "id": "page_c41d9a07", "kind": "content", "layout": { "children": [ { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -27823,11 +27941,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -27840,9 +27964,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "documentTemplate" ], - "example": "reportTemplate", + "example": "documentTemplate", "type": "string" } }, @@ -27853,10 +27977,10 @@ ], "type": "object" }, - "JsonApiReportTemplateInDocument": { + "JsonApiPublisherDocumentTemplateInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplateIn" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateIn" } }, "required": [ @@ -27864,8 +27988,8 @@ ], "type": "object" }, - "JsonApiReportTemplateOut": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiPublisherDocumentTemplateOut": { + "description": "JSON:API representation of documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -27873,244 +27997,191 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], "pages": [ { - "format": "widescreen", + "id": "page_7f3a91c4", "kind": "cover", "layout": { "children": [ { - "slotId": "cover_coverTitle", - "type": "slotRef", - "weight": 2 + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" }, { - "slotId": "cover_coverSubtitle", - "type": "slotRef", - "weight": 1 + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } + }, + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" }, { "children": [ { - "slotId": "cover_footerLogo", - "type": "slotRef", - "weight": 1 + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } }, { - "slotId": "cover_footerPageNumber", - "type": "slotRef", - "weight": 8 + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" } ], - "direction": "row", - "type": "section", - "weight": 1 + "proportion": 9, + "type": "row" } ], - "direction": "column", - "type": "section" - }, - "localIdentifier": "cover", - "slots": [ - { - "localIdentifier": "cover_coverTitle", - "source": { - "content": "{reportName}", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "localIdentifier": "cover_coverSubtitle", - "source": { - "content": "{regionName} · {periodStart} – {periodEnd}", - "type": "static" - }, - "style": { - "type": "h3" - }, - "type": "heading" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "cover_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" + "style": { + "gap": "{theme.spacing.gap.normal}" }, - { - "localIdentifier": "cover_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] + "type": "column" + }, + "notes": "Mention the EMEA promotion." }, { - "format": "widescreen", + "id": "page_3c19e0b7", "kind": "content", "layout": { - "children": [ - { - "slotId": "overview_pageTitle", - "type": "slotRef", - "weight": 2 - }, - { - "children": [ - { - "children": [ - { - "slotId": "overview_widget1", - "type": "slotRef" - }, - { - "slotId": "overview_widget2", - "type": "slotRef" - } - ], - "direction": "row", - "type": "section", - "weight": 2 - }, - { - "slotId": "overview_summary", - "type": "slotRef", - "weight": 1 - } - ], - "direction": "row", - "type": "section", - "weight": 9 - }, - { - "children": [ - { - "slotId": "overview_footerLogo", - "type": "slotRef", - "weight": 1 - }, - { - "slotId": "overview_footerPageNumber", - "type": "slotRef", - "weight": 8 - } - ], - "direction": "row", - "type": "section", - "weight": 1 - } - ], - "direction": "column", - "type": "section" + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" }, - "localIdentifier": "overview", - "slots": [ - { - "localIdentifier": "overview_pageTitle", - "source": { - "content": "Sales overview", - "type": "static" - }, - "style": { - "type": "h1" - }, - "type": "heading" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "revenue_by_month", - "type": "insight" - }, - "localIdentifier": "overview_widget1", - "showTitle": true, - "type": "visualization" - }, - { - "dateDataSet": { - "identifier": "date", - "type": "dataSet" - }, - "insight": { - "identifier": "orders_by_region", - "type": "insight" - }, - "localIdentifier": "overview_widget2", - "showTitle": true, - "type": "visualization" - }, - { - "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" - }, - "style": { - "type": "normalText" - }, - "type": "paragraph" - }, - { - "altText": "Logo", - "fit": "contain", - "localIdentifier": "overview_footerLogo", - "source": { - "type": "url", - "url": "{logo}" - }, - "style": { - "horizontalAlign": "start", - "verticalAlign": "end" - }, - "type": "image" - }, - { - "localIdentifier": "overview_footerPageNumber", - "source": { - "content": "{currentPageNumber} / {totalPages}", - "type": "static" - }, - "style": { - "horizontalAlign": "end", - "type": "largeText", - "verticalAlign": "end" - }, - "type": "paragraph" - } - ] - } - ], - "variables": [ - { - "defaultValue": "All regions", - "description": "Region the report is prepared for", - "name": "regionName", - "title": "Region" + "visible": false } ], - "version": "1" + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } }, "type": "object" }, @@ -28143,11 +28214,17 @@ "title": { "maxLength": 255, "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" } }, "required": [ "content", - "title" + "title", + "version" ], "type": "object" }, @@ -28213,9 +28290,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "documentTemplate" ], - "example": "reportTemplate", + "example": "documentTemplate", "type": "string" } }, @@ -28226,10 +28303,10 @@ ], "type": "object" }, - "JsonApiReportTemplateOutDocument": { + "JsonApiPublisherDocumentTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplateOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOut" }, "included": { "description": "Included resources", @@ -28261,12 +28338,12 @@ ], "type": "object" }, - "JsonApiReportTemplateOutList": { + "JsonApiPublisherDocumentTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -28304,18 +28381,18 @@ ], "type": "object" }, - "JsonApiReportTemplateOutWithLinks": { + "JsonApiPublisherDocumentTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiReportTemplateOut" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiReportTemplatePatch": { - "description": "JSON:API representation of patching reportTemplate entity.", + "JsonApiPublisherDocumentTemplatePatch": { + "description": "JSON:API representation of patching documentTemplate entity.", "properties": { "attributes": { "properties": { @@ -28323,8 +28400,534 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", + "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], + "pages": [ + { + "id": "page_7f3a91c4", + "kind": "cover", + "layout": { + "children": [ + { + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" + }, + { + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } + }, + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" + }, + { + "children": [ + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } + }, + { + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "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": [ + "documentTemplate" + ], + "example": "documentTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePostOptionalId": { + "description": "JSON:API representation of documentTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Content of the document template, validated on write. Missing page and section ids, and the `localIdentifier` of an attribute or date filter, are generated. An invalid value is a 400 whose `path` names the first invalid key, such as `content.pages[0].layout.type`. Maximum supported length is 250000 characters.", + "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } + }, + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], + "pages": [ + { + "id": "page_7f3a91c4", + "kind": "cover", + "layout": { + "children": [ + { + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" + }, + { + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } + }, + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" + }, + { + "children": [ + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } + }, + { + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 + } + }, + "properties": { + "attributeFilterConfigs": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" + }, + "type": "array" + }, + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentPage" + }, + "type": "array" + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentSection" + }, + "type": "array" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" + } + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "version": { + "description": "Version of the content format.", + "example": "2", + "type": "string" + } + }, + "required": [ + "content", + "title", + "version" + ], + "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": [ + "documentTemplate" + ], + "example": "documentTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiPublisherDocumentTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportIn": { + "description": "JSON:API representation of report entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], "pages": [ { "format": "widescreen", @@ -28514,8 +29117,9 @@ }, { "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" }, "style": { "type": "normalText" @@ -28568,6 +29172,18 @@ "maxLength": 10000, "type": "string" }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, "tags": { "items": { "type": "string" @@ -28577,8 +29193,20 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], "type": "object" }, "id": { @@ -28590,9 +29218,9 @@ "type": { "description": "Object type", "enum": [ - "reportTemplate" + "report" ], - "example": "reportTemplate", + "example": "report", "type": "string" } }, @@ -28603,10 +29231,10 @@ ], "type": "object" }, - "JsonApiReportTemplatePatchDocument": { + "JsonApiReportInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiReportTemplatePatch" + "$ref": "#/components/schemas/JsonApiReportIn" } }, "required": [ @@ -28614,8 +29242,8 @@ ], "type": "object" }, - "JsonApiReportTemplatePostOptionalId": { - "description": "JSON:API representation of reportTemplate entity.", + "JsonApiReportOut": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { @@ -28623,14 +29251,32 @@ "type": "boolean" }, "content": { - "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", "example": { - "pages": [ + "filters": [ { - "format": "widescreen", - "kind": "cover", - "layout": { - "children": [ + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ { "slotId": "cover_coverTitle", "type": "slotRef", @@ -28814,8 +29460,9 @@ }, { "localIdentifier": "overview_summary", - "placeholder": { - "hint": "Add a summary" + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" }, "style": { "type": "normalText" @@ -28864,10 +29511,38 @@ }, "type": "object" }, + "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, "type": "string" }, + "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" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, "tags": { "items": { "type": "string" @@ -28877,10 +29552,18 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "required": [ "content", + "periodEnd", + "periodStart", "title" ], "type": "object" @@ -28891,119 +29574,65 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "reportTemplate" - ], - "example": "reportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiReportTemplatePostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeIn": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { + "meta": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" - }, - "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": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemeInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemeIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeOut": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { + "relationships": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], "type": "object" }, - "name": { - "maxLength": 255, - "type": "string" + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, - "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": [ - "theme" + "report" ], - "example": "theme", + "example": "report", "type": "string" } }, @@ -29014,13 +29643,34 @@ ], "type": "object" }, - "JsonApiThemeOutDocument": { + "JsonApiReportOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiThemeOut" + "$ref": "#/components/schemas/JsonApiReportOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" } }, "required": [ @@ -29028,12 +29678,20 @@ ], "type": "object" }, - "JsonApiThemeOutList": { + "JsonApiReportOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29045,6 +29703,14 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true } }, "type": "object" @@ -29055,79 +29721,154 @@ ], "type": "object" }, - "JsonApiThemeOutWithLinks": { + "JsonApiReportOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiThemeOut" + "$ref": "#/components/schemas/JsonApiReportOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiThemePatch": { - "description": "JSON:API representation of patching theme 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": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterIn": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportPageLayoutIn": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, + "type": "object" }, - "maql": { + "description": { "maxLength": 10000, "type": "string" }, @@ -29143,7 +29884,8 @@ } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -29153,39 +29895,12 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -29196,10 +29911,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterInDocument": { + "JsonApiReportPageLayoutInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" } }, "required": [ @@ -29207,47 +29922,189 @@ ], "type": "object" }, - "JsonApiUserDataFilterOut": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportPageLayoutOut": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, + "type": "object" + }, + "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, + "type": "string" + }, + "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" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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", @@ -29273,87 +30130,10 @@ }, "relationships": { "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "computedAttributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "parameters": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "user": { + "createdBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -29361,10 +30141,10 @@ ], "type": "object" }, - "userGroup": { + "modifiedBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -29378,9 +30158,9 @@ "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -29391,15 +30171,15 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutDocument": { + "JsonApiReportPageLayoutOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29426,43 +30206,12 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - } - ] - }, - "JsonApiUserDataFilterOutList": { + "JsonApiReportPageLayoutOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29470,7 +30219,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29500,29 +30249,154 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutWithLinks": { + "JsonApiReportPageLayoutOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserDataFilterPatch": { - "description": "JSON:API representation of patching userDataFilter entity.", + "JsonApiReportPageLayoutPatch": { + "description": "JSON:API representation of patching reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" + }, + "type": "object" }, - "maql": { + "description": { "maxLength": 10000, "type": "string" }, @@ -29545,39 +30419,12 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -29588,10 +30435,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPatchDocument": { + "JsonApiReportPageLayoutPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" } }, "required": [ @@ -29599,77 +30446,176 @@ ], "type": "object" }, - "JsonApiUserDataFilterPostOptionalId": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportPageLayoutPostOptionalId": { + "description": "JSON:API representation of reportPageLayout entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } + "content": { + "description": "Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "widget1", + "type": "slotRef" + }, + { + "slotId": "widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "slots": [ + { + "localIdentifier": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ], + "version": "1" }, - "required": [ - "data" - ], "type": "object" }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" }, - "required": [ - "data" - ], - "type": "object" + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" } }, + "required": [ + "content", + "title" + ], "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": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -29679,10 +30625,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPostOptionalIdDocument": { + "JsonApiReportPageLayoutPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" } }, "required": [ @@ -29690,14 +30636,306 @@ ], "type": "object" }, - "JsonApiUserGroupIn": { - "description": "JSON:API representation of userGroup entity.", + "JsonApiReportPatch": { + "description": "JSON:API representation of patching report entity.", "properties": { "attributes": { "properties": { - "name": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "type": "object" @@ -29708,41 +30946,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { "description": "Object type", "enum": [ - "userGroup" + "report" ], - "example": "userGroup", + "example": "report", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserGroupInDocument": { + "JsonApiReportPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupIn" + "$ref": "#/components/schemas/JsonApiReportPatch" } }, "required": [ @@ -29750,35 +30973,4685 @@ ], "type": "object" }, - "JsonApiUserGroupLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "JsonApiReportPostOptionalId": { + "description": "JSON:API representation of report entity.", "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [ + "EMEA" + ] + }, + "displayForm": { + "identifier": "region.name", + "type": "displayForm" + }, + "localIdentifier": "report_filter_region", + "negativeSelection": false, + "title": "Region" + } + } + ], + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "source": { + "content": "Revenue in {regionName} grew **12 %** over {reportDateRange}.", + "type": "static" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", + "type": "string" + }, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } + } + }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], + "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": [ + "report" + ], + "example": "report", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiReportPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateIn": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOut": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "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, + "type": "string" + }, + "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" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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" + }, + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplateOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplateOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" + }, + "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" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiReportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiReportTemplatePatch": { + "description": "JSON:API representation of patching reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplatePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplatePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplatePostOptionalId": { + "description": "JSON:API representation of reportTemplate entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "description": "Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.", + "example": { + "pages": [ + { + "format": "widescreen", + "kind": "cover", + "layout": { + "children": [ + { + "slotId": "cover_coverTitle", + "type": "slotRef", + "weight": 2 + }, + { + "slotId": "cover_coverSubtitle", + "type": "slotRef", + "weight": 1 + }, + { + "children": [ + { + "slotId": "cover_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "cover_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "cover", + "slots": [ + { + "localIdentifier": "cover_coverTitle", + "source": { + "content": "{reportName}", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "localIdentifier": "cover_coverSubtitle", + "source": { + "content": "{regionName} · {periodStart} – {periodEnd}", + "type": "static" + }, + "style": { + "type": "h3" + }, + "type": "heading" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "cover_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "cover_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + }, + { + "format": "widescreen", + "kind": "content", + "layout": { + "children": [ + { + "slotId": "overview_pageTitle", + "type": "slotRef", + "weight": 2 + }, + { + "children": [ + { + "children": [ + { + "slotId": "overview_widget1", + "type": "slotRef" + }, + { + "slotId": "overview_widget2", + "type": "slotRef" + } + ], + "direction": "row", + "type": "section", + "weight": 2 + }, + { + "slotId": "overview_summary", + "type": "slotRef", + "weight": 1 + } + ], + "direction": "row", + "type": "section", + "weight": 9 + }, + { + "children": [ + { + "slotId": "overview_footerLogo", + "type": "slotRef", + "weight": 1 + }, + { + "slotId": "overview_footerPageNumber", + "type": "slotRef", + "weight": 8 + } + ], + "direction": "row", + "type": "section", + "weight": 1 + } + ], + "direction": "column", + "type": "section" + }, + "localIdentifier": "overview", + "slots": [ + { + "localIdentifier": "overview_pageTitle", + "source": { + "content": "Sales overview", + "type": "static" + }, + "style": { + "type": "h1" + }, + "type": "heading" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "revenue_by_month", + "type": "insight" + }, + "localIdentifier": "overview_widget1", + "showTitle": true, + "type": "visualization" + }, + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "insight": { + "identifier": "orders_by_region", + "type": "insight" + }, + "localIdentifier": "overview_widget2", + "showTitle": true, + "type": "visualization" + }, + { + "localIdentifier": "overview_summary", + "placeholder": { + "hint": "Add a summary" + }, + "style": { + "type": "normalText" + }, + "type": "paragraph" + }, + { + "altText": "Logo", + "fit": "contain", + "localIdentifier": "overview_footerLogo", + "source": { + "type": "url", + "url": "{logo}" + }, + "style": { + "horizontalAlign": "start", + "verticalAlign": "end" + }, + "type": "image" + }, + { + "localIdentifier": "overview_footerPageNumber", + "source": { + "content": "{currentPageNumber} / {totalPages}", + "type": "static" + }, + "style": { + "horizontalAlign": "end", + "type": "largeText", + "verticalAlign": "end" + }, + "type": "paragraph" + } + ] + } + ], + "variables": [ + { + "defaultValue": "All regions", + "description": "Region the report is prepared for", + "name": "regionName", + "title": "Region" + } + ], + "version": "1" + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "title" + ], + "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": [ + "reportTemplate" + ], + "example": "reportTemplate", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiReportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeIn": { + "description": "JSON:API representation of theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemeInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemeIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOut": { + "description": "JSON:API representation of theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemeOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemeOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiThemePatch": { + "description": "JSON:API representation of patching theme 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": [ + "theme" + ], + "example": "theme", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterIn": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOut": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "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" + }, + "relationships": { + "properties": { + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "labels": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + } + ] + }, + "JsonApiUserDataFilterOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserDataFilterPatch": { + "description": "JSON:API representation of patching userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 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": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserDataFilterPostOptionalId": { + "description": "JSON:API representation of userDataFilter entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "userGroup": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userDataFilter" + ], + "example": "userDataFilter", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiUserDataFilterPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupIn": { + "description": "JSON:API representation of userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userGroup" + ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "userGroup" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupOut": { + "description": "JSON:API representation of userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "userGroup" + ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserGroupOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserGroupPatch": { + "description": "JSON:API representation of patching userGroup entity.", + "properties": { + "attributes": { + "properties": { + "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" + }, + "relationships": { + "properties": { + "parents": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ "userGroup" ], + "example": "userGroup", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserGroupPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserGroupToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + }, + "type": "array" + }, + "JsonApiUserGroupToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + } + ] + }, + "JsonApiUserIdentifierLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "userIdentifier" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserIdentifierOut": { + "description": "JSON:API representation of userIdentifier entity.", + "properties": { + "attributes": { + "properties": { + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "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": [ + "userIdentifier" + ], + "example": "userIdentifier", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserIdentifierOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserIdentifierOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "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" + }, + "JsonApiUserIdentifierOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserIdentifierToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" + } + ] + }, + "JsonApiUserIn": { + "description": "JSON:API representation of user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "user" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserOut": { + "description": "JSON:API representation of user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserPatch": { + "description": "JSON:API representation of patching user entity.", + "properties": { + "attributes": { + "properties": { + "authenticationId": { + "maxLength": 255, + "type": "string" + }, + "email": { + "maxLength": 255, + "type": "string" + }, + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { + "maxLength": 255, + "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "userGroups": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "user" + ], + "example": "user", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingIn": { + "description": "JSON:API representation of userSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "userSetting" + ], + "example": "userSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOut": { + "description": "JSON:API representation of userSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "userSetting" + ], + "example": "userSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiUserSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiUserSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiUserLinkage" + }, + "type": "array" + }, + "JsonApiUserToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiUserLinkage" + } + ] + }, + "JsonApiVisualizationObjectIn": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "visualizationObject" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOut": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "certification": { + "description": "Certification status of the entity.", + "enum": [ + "CERTIFIED" + ], + "type": "string" + }, + "certificationMessage": { + "description": "Optional message associated with the certification.", + "nullable": true, + "type": "string" + }, + "certifiedAt": { + "description": "Time when the certification was set.", + "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" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "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, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "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" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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" + }, + "permissions": { + "description": "List of valid permissions for a logged-in user.", + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "labels": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiVisualizationObjectPatch": { + "description": "JSON:API representation of patching visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPostOptionalId": { + "description": "JSON:API representation of visualizationObject entity.", + "properties": { + "attributes": { + "properties": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, + "properties": { + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" + }, + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingRule" + }, + "type": "array" + } + }, + "required": [ + "enabled", + "rules" + ], + "type": "object" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content" + ], + "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": [ + "visualizationObject" + ], + "example": "visualizationObject", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiVisualizationObjectPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiVisualizationObjectToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" + }, + "type": "array" + }, + "JsonApiVisualizationObjectToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" + } + ] + }, + "JsonApiWorkspaceAutomationOut": { + "description": "JSON:API representation of workspaceAutomation entity.", + "properties": { + "attributes": { + "properties": { + "alert": { + "properties": { + "condition": { + "$ref": "#/components/schemas/AlertCondition" + }, + "execution": { + "$ref": "#/components/schemas/AlertAfm" + }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "trigger": { + "default": "ALWAYS", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum": [ + "ALWAYS", + "ONCE", + "ONCE_PER_INTERVAL" + ], + "type": "string" + } + }, + "required": [ + "condition", + "execution" + ], + "type": "object" + }, + "areRelationsValid": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "dashboardTabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "details": { + "description": "Additional details to be included in the automated message.", + "maxLength": 10000, + "type": "object" + }, + "evaluationMode": { + "description": "Specify automation evaluation mode.", + "enum": [ + "SHARED", + "PER_RECIPIENT" + ], + "type": "string" + }, + "externalRecipients": { + "description": "External recipients of the automation action results.", + "items": { + "properties": { + "email": { + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object" + }, + "type": "array" + }, + "imageExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/ImageExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": true, + "description": "Additional information for the automation.", + "maxLength": 250000, + "nullable": true, + "properties": { + "visibleFilters": { + "items": { + "$ref": "#/components/schemas/VisibleFilter" + }, + "type": "array" + }, + "widget": { + "type": "string" + } + }, + "type": "object" + }, + "modifiedAt": { + "format": "date-time", + "type": "string" + }, + "rawExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/RawExportAutomationRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "schedule": { + "properties": { + "cron": { + "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example": "0 */30 9-17 ? * MON-FRI", + "maxLength": 255, + "type": "string" + }, + "cronDescription": { + "description": "Human-readable description of the cron expression.", + "readOnly": true, + "type": "string" + }, + "firstRun": { + "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example": "2025-01-01T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "timezone": { + "description": "Timezone in which the schedule is defined.", + "example": "Europe/Prague", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "cron", + "timezone" + ], + "type": "object" + }, + "slidesExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/SlidesExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Current state of the automation.", + "enum": [ + "ACTIVE", + "PAUSED" + ], + "type": "string" + }, + "tabularExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/TabularExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "visualExports": { + "items": { + "properties": { + "requestPayload": { + "$ref": "#/components/schemas/VisualExportRequest" + } + }, + "required": [ + "requestPayload" + ], + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "relationships": { + "properties": { + "analyticalDashboard": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "automationResults": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "exportDefinitions": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "notificationChannel": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "recipients": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "workspace": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceAutomation" + ], + "example": "workspaceAutomation", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + } + ] + }, + "JsonApiWorkspaceAutomationOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceAutomationOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "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" }, - "JsonApiUserGroupOut": { - "description": "JSON:API representation of userGroup entity.", + "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": { @@ -29787,16 +35660,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "parents": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "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" } @@ -29806,46 +35689,26 @@ "type": { "description": "Object type", "enum": [ - "userGroup" + "workspaceColorPalette" ], - "example": "userGroup", + "example": "workspaceColorPalette", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserGroupOutDocument": { + "JsonApiWorkspaceColorPaletteOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" - }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" } }, "required": [ @@ -29853,20 +35716,12 @@ ], "type": "object" }, - "JsonApiUserGroupOutList": { + "JsonApiWorkspaceColorPaletteOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29878,14 +35733,6 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true } }, "type": "object" @@ -29896,21 +35743,26 @@ ], "type": "object" }, - "JsonApiUserGroupOutWithLinks": { + "JsonApiWorkspaceColorPaletteOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserGroupPatch": { - "description": "JSON:API representation of patching userGroup entity.", + "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" @@ -29924,12 +35776,65 @@ "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": { + "attributes": { + "properties": { + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 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": { - "parents": { + "filterSettings": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" } }, "required": [ @@ -29943,9 +35848,9 @@ "type": { "description": "Object type", "enum": [ - "userGroup" + "workspaceDataFilter" ], - "example": "userGroup", + "example": "workspaceDataFilter", "type": "string" } }, @@ -29955,10 +35860,10 @@ ], "type": "object" }, - "JsonApiUserGroupPatchDocument": { + "JsonApiWorkspaceDataFilterInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupPatch" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" } }, "required": [ @@ -29966,23 +35871,7 @@ ], "type": "object" }, - "JsonApiUserGroupToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" - }, - "type": "array" - }, - "JsonApiUserGroupToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" - } - ] - }, - "JsonApiUserIdentifierLinkage": { + "JsonApiWorkspaceDataFilterLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { @@ -29990,7 +35879,7 @@ }, "type": { "enum": [ - "userIdentifier" + "workspaceDataFilter" ], "type": "string" } @@ -30001,20 +35890,20 @@ ], "type": "object" }, - "JsonApiUserIdentifierOut": { - "description": "JSON:API representation of userIdentifier entity.", + "JsonApiWorkspaceDataFilterOut": { + "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { "attributes": { "properties": { - "email": { + "columnName": { "maxLength": 255, "type": "string" }, - "firstname": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "lastname": { + "title": { "maxLength": 255, "type": "string" } @@ -30027,12 +35916,54 @@ "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" + }, + "relationships": { + "properties": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, "type": { "description": "Object type", "enum": [ - "userIdentifier" + "workspaceDataFilter" ], - "example": "userIdentifier", + "example": "workspaceDataFilter", "type": "string" } }, @@ -30042,13 +35973,34 @@ ], "type": "object" }, - "JsonApiUserIdentifierOutDocument": { + "JsonApiWorkspaceDataFilterOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { + "properties": { + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" } }, "required": [ @@ -30056,12 +36008,20 @@ ], "type": "object" }, - "JsonApiUserIdentifierOutList": { + "JsonApiWorkspaceDataFilterOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30073,6 +36033,14 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" + }, + "restricted": { + "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", + "items": { + "$ref": "#/components/schemas/RestrictedObject" + }, + "type": "array", + "uniqueItems": true } }, "type": "object" @@ -30083,50 +36051,102 @@ ], "type": "object" }, - "JsonApiUserIdentifierOutWithLinks": { + "JsonApiWorkspaceDataFilterOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserIdentifierToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" - } - ] - }, - "JsonApiUserIn": { - "description": "JSON:API representation of user entity.", + "JsonApiWorkspaceDataFilterPatch": { + "description": "JSON:API representation of patching workspaceDataFilter entity.", "properties": { "attributes": { "properties": { - "authenticationId": { + "columnName": { "maxLength": 255, "type": "string" }, - "email": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "firstname": { + "title": { "maxLength": 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": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilter" + ], + "example": "workspaceDataFilter", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceDataFilterSettingIn": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" }, - "lastname": { + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -30139,10 +36159,10 @@ }, "relationships": { "properties": { - "userGroups": { + "workspaceDataFilter": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ @@ -30156,9 +36176,9 @@ "type": { "description": "Object type", "enum": [ - "user" + "workspaceDataFilterSetting" ], - "example": "user", + "example": "workspaceDataFilterSetting", "type": "string" } }, @@ -30168,10 +36188,10 @@ ], "type": "object" }, - "JsonApiUserInDocument": { + "JsonApiWorkspaceDataFilterSettingInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIn" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" } }, "required": [ @@ -30179,7 +36199,7 @@ ], "type": "object" }, - "JsonApiUserLinkage": { + "JsonApiWorkspaceDataFilterSettingLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { @@ -30187,7 +36207,7 @@ }, "type": { "enum": [ - "user" + "workspaceDataFilterSetting" ], "type": "string" } @@ -30198,31 +36218,24 @@ ], "type": "object" }, - "JsonApiUserOut": { - "description": "JSON:API representation of user entity.", + "JsonApiWorkspaceDataFilterSettingOut": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "firstname": { - "maxLength": 255, - "type": "string" + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" }, - "lastname": { + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -30233,12 +36246,38 @@ "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" + }, "relationships": { "properties": { - "userGroups": { + "workspaceDataFilter": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ @@ -30252,9 +36291,9 @@ "type": { "description": "Object type", "enum": [ - "user" + "workspaceDataFilterSetting" ], - "example": "user", + "example": "workspaceDataFilterSetting", "type": "string" } }, @@ -30264,15 +36303,15 @@ ], "type": "object" }, - "JsonApiUserOutDocument": { + "JsonApiWorkspaceDataFilterSettingOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30299,12 +36338,12 @@ ], "type": "object" }, - "JsonApiUserOutList": { + "JsonApiWorkspaceDataFilterSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30312,7 +36351,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30342,41 +36381,34 @@ ], "type": "object" }, - "JsonApiUserOutWithLinks": { + "JsonApiWorkspaceDataFilterSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserPatch": { - "description": "JSON:API representation of patching user entity.", + "JsonApiWorkspaceDataFilterSettingPatch": { + "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "firstname": { - "maxLength": 255, - "type": "string" + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" }, - "lastname": { + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -30389,10 +36421,10 @@ }, "relationships": { "properties": { - "userGroups": { + "workspaceDataFilter": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ @@ -30406,9 +36438,9 @@ "type": { "description": "Object type", "enum": [ - "user" + "workspaceDataFilterSetting" ], - "example": "user", + "example": "workspaceDataFilterSetting", "type": "string" } }, @@ -30418,10 +36450,10 @@ ], "type": "object" }, - "JsonApiUserPatchDocument": { + "JsonApiWorkspaceDataFilterSettingPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserPatch" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" } }, "required": [ @@ -30429,81 +36461,226 @@ ], "type": "object" }, - "JsonApiUserSettingIn": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiWorkspaceDataFilterSettingToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" + }, + "type": "array" + }, + "JsonApiWorkspaceDataFilterToManyLinkage": { + "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + }, + "type": "array" + }, + "JsonApiWorkspaceDataFilterToOneLinkage": { + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + } + ] + }, + "JsonApiWorkspaceExportTemplateIn": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + "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", + "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, + "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": { @@ -30512,25 +36689,55 @@ "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": [ - "userSetting" + "workspaceExportTemplate" ], - "example": "userSetting", + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserSettingInDocument": { + "JsonApiWorkspaceExportTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -30538,79 +36745,119 @@ ], "type": "object" }, - "JsonApiUserSettingOut": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching workspaceExportTemplate entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + "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": "string" + "type": "object" } }, "type": "object" @@ -30624,25 +36871,23 @@ "type": { "description": "Object type", "enum": [ - "userSetting" + "workspaceExportTemplate" ], - "example": "userSetting", + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserSettingOutDocument": { + "JsonApiWorkspaceExportTemplatePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" } }, "required": [ @@ -30650,121 +36895,187 @@ ], "type": "object" }, - "JsonApiUserSettingOutList": { - "description": "A JSON:API document with a list of resources", + "JsonApiWorkspaceExportTemplatePostOptionalId": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { + "attributes": { "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "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": [ - "data" + "attributes", + "type" ], "type": "object" }, - "JsonApiUserSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" } - ] - }, - "JsonApiUserToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserLinkage" }, - "type": "array" - }, - "JsonApiUserToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserLinkage" - } - ] + "required": [ + "data" + ], + "type": "object" }, - "JsonApiVisualizationObjectIn": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiWorkspaceIn": { + "description": "JSON:API representation of workspace entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" + "cacheExtraLimit": { + "format": "int64", + "type": "integer" }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, + "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": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" }, "type": "array" } }, "required": [ - "enabled", - "rules" + "id" ], "type": "object" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, "description": { - "maxLength": 10000, + "maxLength": 255, + "nullable": true, "type": "string" }, - "isHidden": { - "type": "boolean" + "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" }, - "tags": { + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { + "maxLength": 255, "type": "string" }, + "nullable": true, "type": "array" }, - "title": { + "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" } }, - "required": [ - "content" - ], "type": "object" }, "id": { @@ -30773,26 +37084,41 @@ "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": [ - "visualizationObject" + "workspace" ], - "example": "visualizationObject", + "example": "workspace", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiVisualizationObjectInDocument": { + "JsonApiWorkspaceInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + "$ref": "#/components/schemas/JsonApiWorkspaceIn" } }, "required": [ @@ -30800,7 +37126,7 @@ ], "type": "object" }, - "JsonApiVisualizationObjectLinkage": { + "JsonApiWorkspaceLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { @@ -30808,7 +37134,7 @@ }, "type": { "enum": [ - "visualizationObject" + "workspace" ], "type": "string" } @@ -30819,104 +37145,76 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOut": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiWorkspaceOut": { + "description": "JSON:API representation of workspace entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "certification": { - "description": "Certification status of the entity.", - "enum": [ - "CERTIFIED" - ], - "type": "string" - }, - "certificationMessage": { - "description": "Optional message associated with the certification.", - "nullable": true, - "type": "string" - }, - "certifiedAt": { - "description": "Time when the certification was set.", - "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" + "cacheExtraLimit": { + "format": "int64", + "type": "integer" }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, + "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": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" }, "type": "array" } }, "required": [ - "enabled", - "rules" + "id" ], "type": "object" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "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, + "maxLength": 255, + "nullable": true, "type": "string" }, - "isHidden": { - "type": "boolean" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "2023-07-20 12:30", - "format": "date-time", + "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, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, - "tags": { + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { + "maxLength": 255, "type": "string" }, + "nullable": true, "type": "array" }, - "title": { + "managed": { + "description": "Whether the object is platform-managed and read-only.", + "type": "boolean" + }, + "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" } }, - "required": [ - "content" - ], "type": "object" }, "id": { @@ -30927,147 +37225,85 @@ }, "meta": { "properties": { - "origin": { + "config": { "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "approximateCountAvailable": { + "default": false, + "description": "is approximate count enabled - based on type of data-source connected to this workspace", + "type": "boolean" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "certifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "computedAttributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], + "dataSamplingAvailable": { + "default": false, + "description": "is sampling enabled - based on type of data-source connected to this workspace", + "type": "boolean" + }, + "showAllValuesOnDatesAvailable": { + "default": false, + "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", + "type": "boolean" + } + }, "type": "object" }, - "metrics": { + "dataModel": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "datasetCount": { + "description": "include the number of dataset of each workspace", + "format": "int32", + "type": "integer" } }, "required": [ - "data" + "datasetCount" ], "type": "object" }, - "modifiedBy": { + "hierarchy": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "childrenCount": { + "description": "include the number of direct children of each workspace", + "format": "int32", + "type": "integer" } }, "required": [ - "data" + "childrenCount" ], "type": "object" }, - "parameters": { + "permissions": { + "description": "List of valid permissions for a logged-in user.", + "items": { + "enum": [ + "MANAGE", + "ANALYZE", + "EXPORT", + "EXPORT_TABULAR", + "EXPORT_PDF", + "CREATE_AUTOMATION", + "USE_AI_ASSISTANT", + "WRITE_KNOWLEDGE_DOCUMENTS", + "READ_KNOWLEDGE_DOCUMENTS", + "CREATE_FILTER_VIEW", + "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", + "CREATE_VISUALIZATION", + "CREATE_COMPUTED_ATTRIBUTE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "parent": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ @@ -31081,28 +37317,27 @@ "type": { "description": "Object type", "enum": [ - "visualizationObject" + "workspace" ], - "example": "visualizationObject", + "example": "workspace", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiVisualizationObjectOutDocument": { + "JsonApiWorkspaceOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31129,12 +37364,12 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutList": { + "JsonApiWorkspaceOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31142,7 +37377,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31172,72 +37407,79 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutWithLinks": { + "JsonApiWorkspaceOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiVisualizationObjectPatch": { - "description": "JSON:API representation of patching visualizationObject entity.", + "JsonApiWorkspacePatch": { + "description": "JSON:API representation of patching workspace entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" + "cacheExtraLimit": { + "format": "int64", + "type": "integer" }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, + "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": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" + "id": { + "description": "The ID of the used data source.", + "example": "snowflake.instance.1", + "type": "string" }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", + "schemaPath": { + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" + "description": "The part of the schema path.", + "example": "subPath", + "type": "string" }, "type": "array" } }, "required": [ - "enabled", - "rules" + "id" ], "type": "object" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, "description": { - "maxLength": 10000, + "maxLength": 255, + "nullable": true, "type": "string" }, - "isHidden": { - "type": "boolean" + "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" }, - "tags": { + "earlyAccessValues": { + "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { + "maxLength": 255, "type": "string" }, + "nullable": true, "type": "array" }, - "title": { + "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" } }, @@ -31249,26 +37491,41 @@ "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": [ - "visualizationObject" + "workspace" ], - "example": "visualizationObject", + "example": "workspace", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiVisualizationObjectPatchDocument": { + "JsonApiWorkspacePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + "$ref": "#/components/schemas/JsonApiWorkspacePatch" } }, "required": [ @@ -31276,68 +37533,81 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalId": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiWorkspaceSettingIn": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { "attributes": { "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "conditionalFormatting": { - "description": "Conditional formatting applied when this visualization is rendered.", - "nullable": true, - "properties": { - "enabled": { - "description": "Whether the rules are applied when rendering.", - "type": "boolean" - }, - "rules": { - "description": "Rules evaluated in order; within a target, the first matching condition wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingRule" - }, - "type": "array" - } - }, - "required": [ - "enabled", - "rules" - ], - "type": "object" - }, "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, "type": "object" }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], "type": "string" } }, - "required": [ - "content" - ], "type": "object" }, "id": { @@ -31349,285 +37619,102 @@ "type": { "description": "Object type", "enum": [ - "visualizationObject" + "workspaceSetting" ], - "example": "visualizationObject", + "example": "workspaceSetting", "type": "string" } }, "required": [ - "attributes", + "id", "type" ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalIdDocument": { + "JsonApiWorkspaceSettingInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" } }, "required": [ "data" - ], - "type": "object" - }, - "JsonApiVisualizationObjectToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" - }, - "type": "array" - }, - "JsonApiVisualizationObjectToOneLinkage": { - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" - } - ] - }, - "JsonApiWorkspaceAutomationOut": { - "description": "JSON:API representation of workspaceAutomation entity.", - "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" - }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" - }, - "interval": { - "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", - "enum": [ - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", - "enum": [ - "ALWAYS", - "ONCE", - "ONCE_PER_INTERVAL" - ], - "type": "string" - } - }, - "required": [ - "condition", - "execution" - ], - "type": "object" - }, - "areRelationsValid": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" - } - }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" - }, - "type": "array" - }, - "widget": { - "type": "string" - } - }, - "type": "object" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" - }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" - }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" - }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingOut": { + "description": "JSON:API representation of workspaceSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "state": { - "description": "Current state of the automation.", + "type": { "enum": [ - "ACTIVE", - "PAUSED" + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" } }, "type": "object" @@ -31638,93 +37725,26 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "automationResults": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "workspace": { + "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" } @@ -31734,9 +37754,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceAutomation" + "workspaceSetting" ], - "example": "workspaceAutomation", + "example": "workspaceSetting", "type": "string" } }, @@ -31746,45 +37766,26 @@ ], "type": "object" }, - "JsonApiWorkspaceAutomationOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "JsonApiWorkspaceSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" }, - { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "links": { + "$ref": "#/components/schemas/ObjectLinks" } - ] + }, + "required": [ + "data" + ], + "type": "object" }, - "JsonApiWorkspaceAutomationOutList": { + "JsonApiWorkspaceSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31796,14 +37797,6 @@ "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true } }, "type": "object" @@ -31814,18 +37807,235 @@ ], "type": "object" }, - "JsonApiWorkspaceAutomationOutWithLinks": { + "JsonApiWorkspaceSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceColorPaletteIn": { - "description": "JSON:API representation of workspaceColorPalette entity.", + "JsonApiWorkspaceSettingPatch": { + "description": "JSON:API representation of patching workspaceSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "workspaceSetting" + ], + "example": "workspaceSetting", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingPostOptionalId": { + "description": "JSON:API representation of workspaceSetting entity.", + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "type": { + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "ACTIVE_LLM_PROVIDER", + "ACTIVE_CALENDARS", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "GEO_ICON_SHEET", + "AG_GRID_TOKEN", + "WEEK_START", + "FISCAL_YEAR", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG", + "ENABLE_FILE_ANALYTICS", + "ALERT", + "SEPARATORS", + "DATE_FILTER_CONFIG", + "JIT_PROVISIONING", + "JWT_JIT_PROVISIONING", + "DASHBOARD_FILTERS_APPLY_MODE", + "ENABLE_SLIDES_EXPORT", + "DEFAULT_EXPORT_TEMPLATE", + "ENABLE_SNAPSHOT_EXPORT", + "AI_RATE_LIMIT", + "ATTACHMENT_SIZE_LIMIT", + "ATTACHMENT_LINK_TTL", + "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + "ENABLE_DRILL_TO_URL_BY_DEFAULT", + "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + "ENABLE_AUTOMATION_EVALUATION_MODE", + "ENABLE_ACCESSIBILITY_MODE", + "REGISTERED_PLUGGABLE_APPLICATIONS", + "DATA_LOCALE", + "LDM_DEFAULT_LOCALE", + "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + "MAX_ZOOM_LEVEL", + "CONVERSATION_RETENTION_DAYS", + "SORT_CASE_SENSITIVE", + "SORT_COLLATION", + "METRIC_FORMAT_OVERRIDE", + "ENABLE_AI_ON_DATA", + "ENABLE_AI_DATA_OBFUSCATION", + "ENABLE_PARTIAL_DATA_RESULTS", + "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + "ENABLE_NULL_JOINS", + "EXPORT_CSV_CUSTOM_DELIMITER", + "ENABLE_QUERY_TAGS", + "RESTRICT_BASE_UI", + "CERTIFY_PARENT_OBJECTS", + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "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": [ + "workspaceSetting" + ], + "example": "workspaceSetting", + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "JsonApiWorkspaceSettingPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { "attributes": { "properties": { @@ -31854,9 +38064,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceColorPalette" + "workspaceTheme" ], - "example": "workspaceColorPalette", + "example": "workspaceTheme", "type": "string" } }, @@ -31867,10 +38077,10 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteInDocument": { + "JsonApiWorkspaceThemeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" } }, "required": [ @@ -31878,8 +38088,8 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOut": { - "description": "JSON:API representation of workspaceColorPalette entity.", + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { "attributes": { "properties": { @@ -31934,9 +38144,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceColorPalette" + "workspaceTheme" ], - "example": "workspaceColorPalette", + "example": "workspaceTheme", "type": "string" } }, @@ -31947,10 +38157,10 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutDocument": { + "JsonApiWorkspaceThemeOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -31961,12 +38171,12 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutList": { + "JsonApiWorkspaceThemeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31988,18 +38198,18 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutWithLinks": { + "JsonApiWorkspaceThemeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceColorPalettePatch": { - "description": "JSON:API representation of patching workspaceColorPalette entity.", + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", "properties": { "attributes": { "properties": { @@ -32024,9 +38234,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceColorPalette" + "workspaceTheme" ], - "example": "workspaceColorPalette", + "example": "workspaceTheme", "type": "string" } }, @@ -32037,10 +38247,10 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPalettePatchDocument": { + "JsonApiWorkspaceThemePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" } }, "required": [ @@ -32048,54 +38258,37 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterIn": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "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, + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" + } + ] + }, + "JsonNode": { + "description": "Free-form JSON object", + "example": {}, + "maxLength": 15000, + "nullable": true, + "type": "object" + }, + "LabelIdentifier": { + "description": "A label identifier.", "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, "id": { - "description": "API identifier of an object", - "example": "id1", + "description": "Label ID.", + "example": "label_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { - "description": "Object type", + "description": "A type of the label.", "enum": [ - "workspaceDataFilter" + "label" ], - "example": "workspaceDataFilter", + "example": "label", "type": "string" } }, @@ -32105,3761 +38298,5488 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterInDocument": { + "LabelPermissions": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + "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": [ - "data" + "rules", + "userGroups", + "users" ], "type": "object" }, - "JsonApiWorkspaceDataFilterLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "LabelPermissionsAssignment": { + "description": "Desired levels of permissions on a label for an assignee.", "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "workspaceDataFilter" - ], - "type": "string" + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "type" + "permissions" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOut": { - "description": "JSON:API representation of workspaceDataFilter entity.", - "properties": { - "attributes": { + "LabelPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" + }, + { "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 255, - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" + } + ], + "description": "Desired levels of label permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "LabelPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" }, - "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" + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" } }, "type": "object" + } + ], + "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "ListLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectLinks" }, - "relationships": { + { "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "next": { + "description": "A string containing the link's URL for the next page of data.", + "format": "uri", + "type": "string" } }, "type": "object" + } + ] + }, + "LiveFeatureFlagConfiguration": { + "properties": { + "host": { + "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", + "key": { "type": "string" } }, "required": [ - "id", - "type" + "host", + "key" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "LiveFeatures": { + "allOf": [ + { + "$ref": "#/components/schemas/Features" }, - "meta": { + { "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true + "configuration": { + "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" } }, "type": "object" } + ], + "description": "Structure for featureHub", + "required": [ + "configuration", + "context" + ], + "type": "object" + }, + "LocalIdentifier": { + "properties": { + "format": { + "default": "#,##0.00", + "description": "Metric format.", + "example": "#,##0", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "localIdentifier": { + "description": "Local identifier of the metric to be compared.", + "example": "m1", + "type": "string" + }, + "title": { + "description": "Metric title.", + "example": "Revenue", + "maxLength": 255, + "nullable": true, + "type": "string" + } }, "required": [ - "data" + "localIdentifier" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutList": { - "description": "A JSON:API document with a list of resources", + "LocaleRequest": { "properties": { - "data": { + "locale": { + "description": "Requested locale in the form of language tag (see RFC 5646).", + "example": "en-US", + "type": "string" + } + }, + "required": [ + "locale" + ], + "type": "object" + }, + "LocalizationContent": { + "properties": { + "value": { + "description": "Language tag, or null when no language is set.", + "example": "de-DE", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "LocalizationCount": { + "properties": { + "bySource": { + "$ref": "#/components/schemas/LocalizationSourceCounts" + }, + "total": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "bySource", + "total" + ], + "type": "object" + }, + "LocalizationDataStatistics": { + "description": "Translations of labels in the logical data model. `locales` lists the languages with at least one label translation, sorted. Language tags do not include extensions.", + "properties": { + "locales": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$ref": "#/components/schemas/LocalizationStatisticsLocale" }, - "type": "array", - "uniqueItems": true + "type": "array" + } + }, + "required": [ + "locales" + ], + "type": "object" + }, + "LocalizationDefault": { + "description": "The value a workspace gets for one setting when it and its parents set nothing, and where it comes from. Null when that value has no language.", + "nullable": true, + "properties": { + "content": { + "$ref": "#/components/schemas/LocalizationContent" }, - "included": { - "description": "Included resources", + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + "required": [ + "content", + "source" + ], + "type": "object" + }, + "LocalizationDefaults": { + "properties": { + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" + }, + "LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" + }, + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationDefault" + } + }, + "type": "object" + }, + "LocalizationMetadataStatistics": { + "description": "Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.", + "properties": { + "locales": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "$ref": "#/components/schemas/LocalizationStatisticsLocale" }, - "type": "array", - "uniqueItems": true + "type": "array" + } + }, + "required": [ + "locales" + ], + "type": "object" + }, + "LocalizationResolvedValue": { + "description": "The value a workspace gets for one setting, and where it comes from. Never null. `content.value` is null when the workspace gets no language.", + "properties": { + "content": { + "$ref": "#/components/schemas/LocalizationContent" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "originId": { + "description": "The ancestor workspace that sets the value. Null unless the source is PARENT.", + "nullable": true, + "type": "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" } }, "required": [ - "data" + "content", + "source" ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "LocalizationResolvedValues": { + "description": "The value for each of the display, metadata and data language settings, with its source.", + "properties": { + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" + }, + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationResolvedValue" } - ] + }, + "required": [ + "DATA_LOCALE", + "LOCALE", + "METADATA_LOCALE" + ], + "type": "object" }, - "JsonApiWorkspaceDataFilterPatch": { - "description": "JSON:API representation of patching workspaceDataFilter entity.", + "LocalizationSettingUsage": { "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 255, - "type": "string" - } + "users": { + "$ref": "#/components/schemas/LocalizationCount" + }, + "workspaces": { + "$ref": "#/components/schemas/LocalizationCount" + } + }, + "required": [ + "users", + "workspaces" + ], + "type": "object" + }, + "LocalizationSettingUsages": { + "description": "The same counts per setting. Settings without this language are left out.", + "properties": { + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" + }, + "LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" + }, + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationSettingUsage" + } + }, + "type": "object" + }, + "LocalizationSourceCounts": { + "description": "Counts per source. Sources without any count are left out. In the organization, users without their own setting have no source and are only in the total.", + "properties": { + "DEFAULT": { + "format": "int32", + "type": "integer" + }, + "ENVIRONMENT": { + "format": "int32", + "type": "integer" + }, + "ORGANIZATION": { + "format": "int32", + "type": "integer" + }, + "PARENT": { + "format": "int32", + "type": "integer" + }, + "USER": { + "format": "int32", + "type": "integer" + }, + "WORKSPACE": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LocalizationStatistics": { + "properties": { + "data": { + "$ref": "#/components/schemas/LocalizationDataStatistics" + }, + "metadata": { + "$ref": "#/components/schemas/LocalizationMetadataStatistics" + } + }, + "required": [ + "data", + "metadata" + ], + "type": "object" + }, + "LocalizationStatisticsLocale": { + "properties": { + "locale": { + "description": "Language tag.", + "example": "de-DE", + "type": "string" + } + }, + "required": [ + "locale" + ], + "type": "object" + }, + "LocalizationUsage": { + "properties": { + "defaults": { + "$ref": "#/components/schemas/LocalizationDefaults" + }, + "values": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageValue" }, - "type": "object" + "type": "array" + } + }, + "required": [ + "defaults", + "values" + ], + "type": "object" + }, + "LocalizationUsageUser": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationUserValues" + }, + "email": { + "nullable": true, + "type": "string" }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "name": { + "description": "First and last name. Null when the user has neither.", + "nullable": true, + "type": "string" }, - "type": { - "description": "Object type", + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "workspaceDataFilter" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], - "example": "workspaceDataFilter", "type": "string" } }, "required": [ + "bySetting", "id", - "type" + "source" ], "type": "object" }, - "JsonApiWorkspaceDataFilterPatchDocument": { + "LocalizationUsageUsers": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + "totalCount": { + "description": "The total number of users that match the filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageUser" + }, + "type": "array" } }, "required": [ - "data" + "totalCount", + "users" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingIn": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "LocalizationUsageValue": { + "description": "One language. `workspaces` counts the workspaces that get it in any of the settings, once each. `users` counts the users who get it in any of the settings, once each. In the entry with a null value, `users` counts the users who get no language in any setting.", "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" + "bySetting": { + "$ref": "#/components/schemas/LocalizationSettingUsages" + }, + "content": { + "$ref": "#/components/schemas/LocalizationContent" + }, + "users": { + "$ref": "#/components/schemas/LocalizationCount" + }, + "workspaces": { + "$ref": "#/components/schemas/LocalizationCount" + } + }, + "required": [ + "bySetting", + "content", + "users", + "workspaces" + ], + "type": "object" + }, + "LocalizationUsageWorkspace": { + "properties": { + "bySetting": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "childrenCount": { + "description": "Number of direct child workspaces.", + "format": "int32", + "type": "integer" }, "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "name": { + "type": "string" }, - "type": { - "description": "Object type", + "parentId": { + "description": "The parent workspace, or null for a root workspace.", + "nullable": true, + "type": "string" + }, + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "workspaceDataFilterSetting" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], - "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ + "bySetting", + "childrenCount", "id", - "type" + "name", + "source" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingInDocument": { + "LocalizationUsageWorkspaces": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + "totalCount": { + "description": "The total number of workspaces that match the filters.", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageWorkspace" + }, + "type": "array" } }, "required": [ - "data" + "totalCount", + "workspaces" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "LocalizationUserValue": { + "description": "The value a user gets for one setting, and where it comes from. In the organization users list, it is the value the user sets, with source USER. It is null when the user does not set the setting, because the value then depends on the workspace. In the workspace users list, it is never null. It is the value the user sets, with source USER. Otherwise it is the value the workspace gets, with the source of the workspace. For the origin of that value, see `originId` in the workspace usage. `content.value` is null when the user gets no language.", + "nullable": true, "properties": { - "id": { - "type": "string" + "content": { + "$ref": "#/components/schemas/LocalizationContent" }, - "type": { + "source": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", "enum": [ - "workspaceDataFilterSetting" + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" ], "type": "string" } }, "required": [ - "id", - "type" + "content", + "source" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOut": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "LocalizationUserValues": { + "description": "The value the user gets for each setting.", "properties": { - "attributes": { + "DATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" + }, + "LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" + }, + "METADATA_LOCALE": { + "$ref": "#/components/schemas/LocalizationUserValue" + } + }, + "type": "object" + }, + "MatchAttributeFilter": { + "description": "Filter via label with given match type and literal value.", + "properties": { + "matchAttributeFilter": { "properties": { - "description": { - "maxLength": 10000, + "applyOnResult": { + "type": "boolean" + }, + "caseSensitive": { + "default": false, + "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", + "type": "boolean" + }, + "label": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "literal": { + "description": "Literal used to limit label values.", + "example": "value", "type": "string" }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" + "localIdentifier": { + "type": "string" }, - "title": { - "maxLength": 255, + "matchType": { + "description": "Requested match type.", + "enum": [ + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" + ], "type": "string" + }, + "negate": { + "default": false, + "description": "Indicates whether the filter should negate the match.", + "type": "boolean" } }, + "required": [ + "label", + "literal", + "matchType" + ], "type": "object" + } + }, + "required": [ + "matchAttributeFilter" + ], + "type": "object" + }, + "MatomoService": { + "description": "Matomo service.", + "properties": { + "host": { + "description": "Telemetry host to send events to.", + "type": "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "reportingEndpoint": { + "description": "Optional reporting endpoint for proxying telemetry events.", "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" + "siteId": { + "description": "Site ID on telemetry server.", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "host", + "siteId" + ], + "type": "object" + }, + "MeasureDefinition": { + "description": "Abstract metric definition type", + "oneOf": [ + { + "$ref": "#/components/schemas/InlineMeasureDefinition" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + { + "$ref": "#/components/schemas/ArithmeticMeasureDefinition" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", + { + "$ref": "#/components/schemas/SimpleMeasureDefinition" + }, + { + "$ref": "#/components/schemas/PopMeasureDefinition" + } + ], + "type": "object" + }, + "MeasureItem": { + "description": "Metric is a quantity that is calculated from the data.", + "properties": { + "definition": { + "$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.", + "example": "metric_1", + "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" } }, "required": [ - "id", - "type" + "definition", + "localIdentifier" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "MeasureValueCondition": { + "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonCondition" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true + { + "$ref": "#/components/schemas/RangeCondition" + } + ], + "type": "object" + }, + "MeasureValueFilter": { + "description": "Abstract filter definition type filtering by the value of the metric.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + { + "$ref": "#/components/schemas/RangeMeasureValueFilter" }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + { + "$ref": "#/components/schemas/CompoundMeasureValueFilter" + } + ], + "type": "object" + }, + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "properties": { + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" } }, "required": [ - "data" + "definition", + "item" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutList": { - "description": "A JSON:API document with a list of resources", + "MetricPermissions": { "properties": { - "data": { + "rules": { + "description": "List of rules", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "$ref": "#/components/schemas/RulePermission" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "included": { - "description": "Included resources", + "userGroups": { + "description": "List of user groups", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$ref": "#/components/schemas/UserGroupPermission" }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "type": "array" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" }, - "type": "object" + "type": "array" } }, "required": [ - "data" + "rules", + "userGroups", + "users" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { + "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/JsonApiWorkspaceDataFilterSettingOut" + "$ref": "#/components/schemas/MetricPermissionsAssignment" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceDataFilterSettingPatch": { - "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 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": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", - "type": "string" } - }, - "required": [ - "id", - "type" ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" - } - }, + "description": "Desired levels of metric permissions for an assignee identified by an identifier.", "required": [ - "data" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" - }, - "type": "array" - }, - "JsonApiWorkspaceDataFilterToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" - }, - "type": "array" - }, - "JsonApiWorkspaceDataFilterToOneLinkage": { - "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, - "oneOf": [ + "MetricPermissionsForAssigneeRule": { + "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + "$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" }, - "JsonApiWorkspaceExportTemplateIn": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "NegativeAttributeFilter": { + "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { - "attributes": { + "negativeAttributeFilter": { "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" + "applyOnResult": { + "type": "boolean" }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, + "label": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "localIdentifier": { "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" + "notIn": { + "$ref": "#/components/schemas/AttributeFilterElements" + }, + "usesArbitraryValues": { + "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", + "type": "boolean" } }, "required": [ - "name" + "label", + "notIn" ], "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" + "negativeAttributeFilter" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateInDocument": { + "Note": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + "appliesTo": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string", + "xml": { + "attribute": true + } + }, + "category": { + "type": "string", + "xml": { + "attribute": true + } + }, + "content": { + "type": "string" + }, + "id": { + "type": "string", + "xml": { + "attribute": true + } + }, + "otherAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "priority": { + "format": "int32", + "type": "integer", + "xml": { + "attribute": true + } + } + }, + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } + }, + "Notes": { + "properties": { + "note": { + "items": { + "$ref": "#/components/schemas/Note" + }, + "type": "array" } }, "required": [ - "data" + "note" + ], + "type": "object", + "xml": { + "name": "notes", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } + }, + "NotificationChannelDestination": { + "oneOf": [ + { + "$ref": "#/components/schemas/Webhook" + }, + { + "$ref": "#/components/schemas/Smtp" + }, + { + "$ref": "#/components/schemas/DefaultSmtp" + }, + { + "$ref": "#/components/schemas/InPlatform" + } ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOut": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "NumberConstraints": { "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" + "max": { + "format": "double", + "type": "number" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "min": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "NumberParameterDefinition": { + "properties": { + "constraints": { + "$ref": "#/components/schemas/NumberConstraints" }, - "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" + "defaultValue": { + "format": "double", + "type": "number" }, "type": { - "description": "Object type", + "description": "The parameter type.", "enum": [ - "workspaceExportTemplate" + "NUMBER" ], - "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "attributes", - "id", + "defaultValue", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutDocument": { + "ObjectConditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this object.", + "nullable": true, "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "enabled": { + "description": "Whether the conditions are applied when rendering.", + "type": "boolean" } }, "required": [ - "data" + "conditions", + "enabled" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutList": { - "description": "A JSON:API document with a list of resources", + "ObjectLinks": { "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "self": { + "description": "A string containing the link's URL.", + "format": "uri", + "type": "string" } }, "required": [ - "data" + "self" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "ObjectLinksContainer": { + "properties": { + "links": { + "$ref": "#/components/schemas/ObjectLinks" } - ] + }, + "type": "object" }, - "JsonApiWorkspaceExportTemplatePatch": { - "description": "JSON:API representation of patching workspaceExportTemplate entity.", + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", "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" - } - }, - "type": "object" + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "baseUrl": { + "default": "https://api.openai.com/v1", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, + "type": "string" + }, + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, "type": "string" }, "type": { - "description": "Object type", + "description": "Provider type.", "enum": [ - "workspaceExportTemplate" + "OPENAI" ], - "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "attributes", - "id", + "auth", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePatchDocument": { + "OpenAiApiKeyAuth": { + "allOf": [ + { + "properties": { + "apiKey": { + "description": "OpenAI API key.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "Authentication type.", + "enum": [ + "API_KEY" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "type" + ], + "type": "object" + }, + "OpenAiProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAiApiKeyAuth" + } + ], + "type": "object" + }, + "OpenTelemetryService": { + "description": "OpenTelemetry service.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + "host": { + "description": "Telemetry host to send events to.", + "type": "string" } }, "required": [ - "data" + "host" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalId": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "OrganizationAutomationIdentifier": { "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", + "workspaceId": { "type": "string" } }, "required": [ - "attributes", - "type" + "id", + "workspaceId" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { + "OrganizationAutomationManagementBulkRequest": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" + "automations": { + "items": { + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type": "array" } }, "required": [ - "data" + "automations" ], "type": "object" }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", + "OrganizationPermissionAssignment": { + "description": "Organization permission assignments", "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" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "permissions": { + "items": { + "enum": [ + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" + ], + "type": "string" }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", - "type": "string" + "type": "array" } }, "required": [ - "id", - "type" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "JsonApiWorkspaceInDocument": { + "Over": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" + "attributes": { + "items": { + "$ref": "#/components/schemas/IdentifierRef" + }, + "type": "array" } }, "required": [ - "data" + "attributes" ], "type": "object" }, - "JsonApiWorkspaceLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "PageMetadata": { "properties": { - "id": { + "number": { + "description": "The number of the current page", + "format": "int32", + "type": "integer" + }, + "size": { + "description": "The size of the current page", + "format": "int32", + "type": "integer" + }, + "totalElements": { + "description": "The total number of elements", + "format": "int32", + "type": "integer" + }, + "totalPages": { + "description": "The total number of pages", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Parameter": { + "properties": { + "name": { "type": "string" }, - "type": { - "enum": [ - "workspace" - ], + "value": { "type": "string" } }, "required": [ - "id", - "type" + "name", + "value" ], "type": "object" }, - "JsonApiWorkspaceOut": { - "description": "JSON:API representation of workspace entity.", + "ParameterDefinition": { + "description": "Parameter content (type-discriminated).", + "discriminator": { + "mapping": { + "NUMBER": "#/components/schemas/NumberParameterDefinition", + "STRING": "#/components/schemas/StringParameterDefinition" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/NumberParameterDefinition" + }, + { + "$ref": "#/components/schemas/StringParameterDefinition" + } + ], + "type": "object" + }, + "ParameterItem": { + "additionalProperties": true, + "description": "(EXPERIMENTAL) Parameter value for this execution.", "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" - }, - "managed": { - "description": "Whether the object is platform-managed and read-only.", - "type": "boolean" - }, - "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" + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "value": { + "description": "Value to use for this parameter instead of its default.", + "type": "string" + } + }, + "required": [ + "parameter", + "value" + ], + "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" }, - "meta": { - "properties": { - "config": { - "properties": { - "approximateCountAvailable": { - "default": false, - "description": "is approximate count enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "dataSamplingAvailable": { - "default": false, - "description": "is sampling enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "showAllValuesOnDatesAvailable": { - "default": false, - "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", - "type": "boolean" - } - }, - "type": "object" - }, - "dataModel": { - "properties": { - "datasetCount": { - "description": "include the number of dataset of each workspace", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "datasetCount" - ], - "type": "object" - }, - "hierarchy": { - "properties": { - "childrenCount": { - "description": "include the number of direct children of each workspace", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "childrenCount" - ], - "type": "object" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "WRITE_KNOWLEDGE_DOCUMENTS", - "READ_KNOWLEDGE_DOCUMENTS", - "CREATE_FILTER_VIEW", - "CREATE_METRIC", - "MANAGE_VISUALIZATIONS", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + }, + "valueTitle": { + "description": "Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.", + "example": "year 2026", "type": "string" } }, "required": [ "id", - "type" + "title", + "value" ], "type": "object" }, - "JsonApiWorkspaceOutDocument": { + "PdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", + "example": [ + { + "properties": [ + { + "key": "font-size", + "value": "30px" + } + ], + "selector": "th" + } + ], "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" - }, - "included": { - "description": "Included resources", + "properties": { + "description": "List of CSS properties.", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/PdfTableStyleProperty" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "selector": { + "description": "CSS selector where to apply given properties.", + "type": "string" + } + }, + "required": [ + "selector" + ], + "type": "object" + }, + "PdfTableStyleProperty": { + "description": "CSS property.", + "properties": { + "key": { + "description": "CSS property key.", + "type": "string" }, - "meta": { - "properties": { - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" + "value": { + "description": "CSS property value.", + "type": "string" } }, "required": [ - "data" + "key", + "value" ], "type": "object" }, - "JsonApiWorkspaceOutList": { - "description": "A JSON:API document with a list of resources", + "PdmLdmRequest": { + "description": "PDM additions wrapper.", "properties": { - "data": { + "sqls": { + "description": "List of SQL datasets.", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/PdmSql" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "included": { - "description": "Included resources", + "tableOverrides": { + "description": "(BETA) List of table overrides.", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/TableOverride" }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "type": "array" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - }, - "restricted": { - "description": "References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.", - "items": { - "$ref": "#/components/schemas/RestrictedObject" - }, - "type": "array", - "uniqueItems": true - } + "tables": { + "description": "List of physical database tables.", + "items": { + "$ref": "#/components/schemas/DeclarativeTable" }, - "type": "object" + "type": "array" } }, - "required": [ - "data" - ], "type": "object" }, - "JsonApiWorkspaceOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspacePatch": { - "description": "JSON:API representation of patching workspace entity.", + "PdmSql": { + "description": "SQL dataset definition.", "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" - } + "columns": { + "description": "Columns defining SQL dataset.", + "items": { + "$ref": "#/components/schemas/SqlColumn" }, - "type": "object" + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "statement": { + "description": "SQL statement.", + "example": "select * from abc", "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", + "title": { + "description": "SQL dataset title.", + "example": "My special dataset", "type": "string" } }, "required": [ - "id", - "type" + "statement", + "title" ], "type": "object" }, - "JsonApiWorkspacePatchDocument": { + "PermissionsAssignment": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspacePatch" + "assignees": { + "items": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "minItems": 1, + "type": "array" + }, + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" } }, "required": [ - "data" + "assignees" ], "type": "object" }, - "JsonApiWorkspaceSettingIn": { - "description": "JSON:API representation of workspaceSetting entity.", - "properties": { - "attributes": { + "PermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" + }, + { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" + } + ], + "description": "Desired levels of permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "PermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" } - }, + ], + "description": "Desired levels of permissions for a collection of assignees identified by a rule.", "required": [ - "id", - "type" + "assigneeRule", + "permissions" ], "type": "object" }, - "JsonApiWorkspaceSettingInDocument": { + "PlatformUsage": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" + "count": { + "format": "int32", + "type": "integer" + }, + "name": { + "enum": [ + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" + ], + "type": "string" } }, "required": [ - "data" + "name" ], "type": "object" }, - "JsonApiWorkspaceSettingOut": { - "description": "JSON:API representation of workspaceSetting entity.", + "PlatformUsageRequest": { "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], - "type": "string" - } + "usageItemNames": { + "items": { + "enum": [ + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" + ], + "type": "string" }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "usageItemNames" + ], + "type": "object" + }, + "PopDataset": { + "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties": { + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, - "meta": { + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "dataset", + "periodsAgo" + ], + "type": "object" + }, + "PopDatasetMeasureDefinition": { + "description": "Previous period type of metric.", + "properties": { + "previousPeriodMeasure": { "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" - } + "dateDatasets": { + "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "items": { + "$ref": "#/components/schemas/PopDataset" }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "type": "array" + }, + "measureIdentifier": { + "$ref": "#/components/schemas/AfmLocalIdentifier" } }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" + "required": [ + "dateDatasets", + "measureIdentifier" ], - "example": "workspaceSetting", - "type": "string" + "type": "object" } }, "required": [ - "id", - "type" + "previousPeriodMeasure" ], "type": "object" }, - "JsonApiWorkspaceSettingOutDocument": { + "PopDate": { + "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "attribute": { + "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" } }, "required": [ - "data" + "attribute", + "periodsAgo" ], "type": "object" }, - "JsonApiWorkspaceSettingOutList": { - "description": "A JSON:API document with a list of resources", + "PopDateMeasureDefinition": { + "description": "Period over period type of metric.", "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { + "overPeriodMeasure": { "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "dateAttributes": { + "description": "Attributes to use for determining the period to calculate the PoP for.", + "items": { + "$ref": "#/components/schemas/PopDate" + }, + "type": "array" + }, + "measureIdentifier": { + "$ref": "#/components/schemas/AfmLocalIdentifier" } }, + "required": [ + "dateAttributes", + "measureIdentifier" + ], "type": "object" } }, "required": [ - "data" + "overPeriodMeasure" ], "type": "object" }, - "JsonApiWorkspaceSettingOutWithLinks": { - "allOf": [ + "PopMeasureDefinition": { + "oneOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "$ref": "#/components/schemas/PopDatasetMeasureDefinition" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" + "$ref": "#/components/schemas/PopDateMeasureDefinition" } - ] + ], + "type": "object" }, - "JsonApiWorkspaceSettingPatch": { - "description": "JSON:API representation of patching workspaceSetting entity.", + "PositiveAttributeFilter": { + "description": "Filter able to limit element values by label and related selected elements.", "properties": { - "attributes": { + "positiveAttributeFilter": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "applyOnResult": { + "type": "boolean" }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], + "in": { + "$ref": "#/components/schemas/AttributeFilterElements" + }, + "label": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "localIdentifier": { "type": "string" + }, + "usesArbitraryValues": { + "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", + "type": "boolean" } }, + "required": [ + "in", + "label" + ], "type": "object" + } + }, + "required": [ + "positiveAttributeFilter" + ], + "type": "object" + }, + "Profile": { + "properties": { + "entitlements": { + "description": "Defines entitlements for given organization.", + "items": { + "$ref": "#/components/schemas/ApiEntitlement" + }, + "type": "array" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "features": { + "oneOf": [ + { + "$ref": "#/components/schemas/LiveFeatures" + }, + { + "$ref": "#/components/schemas/StaticFeatures" + } + ] + }, + "links": { + "$ref": "#/components/schemas/ProfileLinks" + }, + "name": { "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", + "organizationId": { + "type": "string" + }, + "organizationName": { + "type": "string" + }, + "permissions": { + "items": { + "enum": [ + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" + ], + "type": "string" + }, + "type": "array" + }, + "telemetryConfig": { + "$ref": "#/components/schemas/TelemetryConfig" + }, + "userId": { "type": "string" } }, "required": [ - "id", - "type" + "entitlements", + "features", + "links", + "organizationId", + "organizationName", + "permissions", + "telemetryConfig", + "userId" ], "type": "object" }, - "JsonApiWorkspaceSettingPatchDocument": { + "ProfileLinks": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" + "organization": { + "type": "string" + }, + "self": { + "type": "string" + }, + "user": { + "type": "string" } }, "required": [ - "data" + "organization", + "self", + "user" ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalId": { - "description": "JSON:API representation of workspaceSetting entity.", + "PublisherDocumentArbitraryAttributeFilter": { + "description": "Filters an attribute display form by arbitrary values.", "properties": { - "attributes": { + "arbitraryAttributeFilter": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_PROVIDER", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "GEO_ICON_SHEET", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "DEFAULT_EXPORT_TEMPLATE", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "CONVERSATION_RETENTION_DAYS", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_AI_DATA_OBFUSCATION", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE", - "ENABLE_TIMEZONE_CHANGE", - "DEFAULT_VISUALIZATION_VISIBILITY", - "DEFAULT_METRIC_VISIBILITY", - "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" - ], + "filterElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParent" + }, + "type": "array" + }, + "filterElementsByDate": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterByDate" + }, + "type": "array" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "validateElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" + }, + "values": { + "description": "Values; `null` stands for an empty value.", + "items": { + "type": "string" + }, + "type": "array" } }, + "required": [ + "displayForm", + "negativeSelection", + "values" + ], "type": "object" + } + }, + "required": [ + "arbitraryAttributeFilter" + ], + "type": "object" + }, + "PublisherDocumentAreaStyle": { + "description": "Style of the area behind the pages. Lengths are in canvas px.", + "properties": { + "backgroundColor": { + "type": "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], "type": "string" }, - "type": { - "description": "Object type", + "backgroundHorizontalAlign": { "enum": [ - "workspaceSetting" + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" ], - "example": "workspaceSetting", "type": "string" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + } + }, + "type": "object" + }, + "PublisherDocumentAttributeElements": { + "description": "Selected attribute elements: `{\"values\": [...]}` or `{\"uris\": [...]}`.", + "oneOf": [ + { + "$ref": "#/components/schemas/PublisherDocumentAttributeElementsByValue" + }, + { + "$ref": "#/components/schemas/PublisherDocumentAttributeElementsByUri" + } + ], + "type": "object" + }, + "PublisherDocumentAttributeElementsByUri": { + "properties": { + "uris": { + "description": "Element URIs; `null` stands for an empty value.", + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "type" + "uris" ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalIdDocument": { + "PublisherDocumentAttributeElementsByValue": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" + "values": { + "description": "Element values; `null` stands for an empty value.", + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "values" ], "type": "object" }, - "JsonApiWorkspaceThemeIn": { - "description": "JSON:API representation of workspaceTheme entity.", + "PublisherDocumentAttributeFilter": { + "description": "Filters an attribute display form by a list of elements.", "properties": { - "attributes": { + "attributeFilter": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "attributeElements": { + "$ref": "#/components/schemas/PublisherDocumentAttributeElements" }, - "name": { - "maxLength": 255, + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "filterElementsBy": { + "description": "Parent filters that limit the offered elements.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParent" + }, + "type": "array" + }, + "filterElementsByDate": { + "description": "Date filters that limit the offered elements.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterByDate" + }, + "type": "array" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "selectionMode": { + "enum": [ + "single", + "multi" + ], + "type": "string" + }, + "title": { "type": "string" + }, + "validateElementsBy": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" } }, "required": [ - "content", - "name" + "attributeElements", + "displayForm", + "negativeSelection" ], "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" + "attributeFilter" ], "type": "object" }, - "JsonApiWorkspaceThemeInDocument": { + "PublisherDocumentAttributeFilterByDate": { + "description": "A date filter that limits the offered elements.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "filterLocalIdentifier": { + "type": "string" + }, + "isCommonDate": { + "type": "boolean" } }, "required": [ - "data" + "filterLocalIdentifier", + "isCommonDate" ], "type": "object" }, - "JsonApiWorkspaceThemeOut": { - "description": "JSON:API representation of workspaceTheme entity.", + "PublisherDocumentAttributeFilterConfig": { + "description": "How a document attribute filter is shown, as in dashboards.", "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" + "displayAsLabel": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "localIdentifier": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "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" + "mode": { + "enum": [ + "readonly", + "hidden", + "active" + ], + "type": "string" }, - "type": { - "description": "Object type", + "selectionType": { "enum": [ - "workspaceTheme" + "list", + "text", + "listOrText" ], - "example": "workspaceTheme", "type": "string" } }, "required": [ - "attributes", - "id", - "type" + "localIdentifier" ], "type": "object" }, - "JsonApiWorkspaceThemeOutDocument": { + "PublisherDocumentAttributeFilterParent": { + "description": "A parent attribute filter that limits the offered elements.", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "filterLocalIdentifier": { + "type": "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "over": { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterParentOver" } }, "required": [ - "data" + "filterLocalIdentifier", + "over" ], "type": "object" }, - "JsonApiWorkspaceThemeOutList": { - "description": "A JSON:API document with a list of resources", + "PublisherDocumentAttributeFilterParentOver": { + "description": "Attributes that connect the parent and the child filter in the data model.", "properties": { - "data": { + "attributes": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "type": "array" } }, "required": [ - "data" + "attributes" ], "type": "object" }, - "JsonApiWorkspaceThemeOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceThemePatch": { - "description": "JSON:API representation of patching workspaceTheme entity.", + "PublisherDocumentAttributeFilterReference": { "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" + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, "type": { - "description": "Object type", "enum": [ - "workspaceTheme" + "attributeFilterReference" ], - "example": "workspaceTheme", "type": "string" } }, "required": [ - "attributes", - "id", + "displayForm", "type" ], "type": "object" }, - "JsonApiWorkspaceThemePatchDocument": { + "PublisherDocumentAutoVisibility": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + "visible": { + "description": "`true`, `false` or `\"auto\"`.", + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + } + ] } }, - "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" + "PublisherDocumentAxisDisplay": { + "properties": { + "max": { + "format": "double", + "type": "number" + }, + "min": { + "format": "double", + "type": "number" + }, + "name": { + "$ref": "#/components/schemas/PublisherDocumentAxisNameDisplay" + }, + "values": { + "$ref": "#/components/schemas/PublisherDocumentAxisValuesDisplay" + }, + "visible": { + "type": "boolean" } - ] - }, - "JsonNode": { - "description": "Free-form JSON object", - "example": {}, - "maxLength": 15000, - "nullable": true, + }, "type": "object" }, - "LabelIdentifier": { - "description": "A label identifier.", + "PublisherDocumentAxisNameDisplay": { "properties": { - "id": { - "description": "Label ID.", - "example": "label_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "position": { + "enum": [ + "low", + "middle", + "high" + ], "type": "string" }, - "type": { - "description": "A type of the label.", + "visible": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublisherDocumentAxisValuesDisplay": { + "properties": { + "rotation": { + "description": "Label rotation in degrees, from -90 to 90.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "visible": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublisherDocumentBoundedFilter": { + "description": "One open end of a relative date filter: exactly one of `from` and `to`.", + "properties": { + "from": { + "format": "int32", + "type": "integer" + }, + "granularity": { "enum": [ - "label" + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" ], - "example": "label", "type": "string" + }, + "to": { + "format": "int32", + "type": "integer" } }, "required": [ - "id", - "type" + "granularity" ], "type": "object" }, - "LabelPermissions": { + "PublisherDocumentChartStyle": { + "description": "Chart style overrides; stored, not applied. Lengths are in canvas px.", "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" + "axisLineColor": { + "type": "string" }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" + "axisNameColor": { + "type": "string" }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" - }, - "type": "array" + "axisNameSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "axisValueColor": { + "type": "string" + }, + "axisValueSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "dataLabelColor": { + "type": "string" + }, + "dataLabelSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "gridColor": { + "type": "string" + }, + "legendColor": { + "type": "string" + }, + "legendSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "plotLineColor": { + "type": "string" + }, + "textColor": { + "type": "string" } }, - "required": [ - "rules", - "userGroups", - "users" - ], "type": "object" }, - "LabelPermissionsAssignment": { - "description": "Desired levels of permissions on a label for an assignee.", + "PublisherDocumentColumn": { + "description": "Lays its children out top to bottom.", "properties": { - "permissions": { + "children": { + "description": "Child nodes from top to bottom, in reading order; an empty list is a spacer.", "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" }, "type": "array" + }, + "id": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the container in the document editor; never checked on write.", + "type": "boolean" + }, + "proportion": { + "description": "Share of the parent's main axis, greater than 0. Default 1.", + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentContainerStyle" + }, + "type": { + "enum": [ + "column" + ], + "type": "string" } }, "required": [ - "permissions" + "children", + "type" ], "type": "object" }, - "LabelPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" - }, - { + "PublisherDocumentComparisonCondition": { + "properties": { + "comparison": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "operator": { + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO" + ], + "type": "string" + }, + "treatNullValuesAs": { + "format": "double", + "type": "number" + }, + "value": { + "format": "double", + "type": "number" } }, + "required": [ + "operator", + "value" + ], "type": "object" } - ], - "description": "Desired levels of label permissions for an assignee identified by an identifier.", + }, "required": [ - "assigneeIdentifier", - "permissions" + "comparison" ], "type": "object" }, - "LabelPermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" + "PublisherDocumentContainerStyle": { + "description": "Style of a row or column; its content inherits the text keys. Lengths are in canvas px.", + "properties": { + "backgroundColor": { + "type": "string" + }, + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" - } - ], - "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], - "type": "object" - }, - "ListLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/ObjectLinks" + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" }, - { - "properties": { - "next": { - "description": "A string containing the link's URL for the next page of data.", - "format": "uri", + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { "type": "string" } - }, - "type": "object" - } - ] - }, - "LiveFeatureFlagConfiguration": { - "properties": { - "host": { + ] + }, + "borderRightColor": { "type": "string" }, - "key": { + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], "type": "string" - } - }, - "required": [ - "host", - "key" - ], - "type": "object" - }, - "LiveFeatures": { - "allOf": [ - { - "$ref": "#/components/schemas/Features" }, - { - "properties": { - "configuration": { - "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" - } - }, - "type": "object" - } - ], - "description": "Structure for featureHub", - "required": [ - "configuration", - "context" - ], - "type": "object" - }, - "LocalIdentifier": { - "properties": { - "format": { - "default": "#,##0.00", - "description": "Metric format.", - "example": "#,##0", - "maxLength": 2048, - "nullable": true, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], "type": "string" }, - "localIdentifier": { - "description": "Local identifier of the metric to be compared.", - "example": "m1", + "borderTopColor": { "type": "string" }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "LocaleRequest": { - "properties": { - "locale": { - "description": "Requested locale in the form of language tag (see RFC 5646).", - "example": "en-US", + }, + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], "type": "string" - } - }, - "required": [ - "locale" - ], - "type": "object" - }, - "MatchAttributeFilter": { - "description": "Filter via label with given match type and literal value.", - "properties": { - "matchAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "caseSensitive": { - "default": false, - "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", - "type": "boolean" + { + "type": "string" + } + ] + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "literal": { - "description": "Literal used to limit label values.", - "example": "value", + { "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "localIdentifier": { + { "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "matchType": { - "description": "Requested match type.", - "enum": [ - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" - ], + { "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "negate": { - "default": false, - "description": "Indicates whether the filter should negate the match.", - "type": "boolean" + { + "type": "string" } - }, - "required": [ - "label", - "literal", - "matchType" - ], - "type": "object" - } - }, - "required": [ - "matchAttributeFilter" - ], - "type": "object" - }, - "MatomoService": { - "description": "Matomo service.", - "properties": { - "host": { - "description": "Telemetry host to send events to.", + ] + }, + "shadow": { "type": "string" }, - "reportingEndpoint": { - "description": "Optional reporting endpoint for proxying telemetry events.", + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { "type": "string" }, - "siteId": { - "description": "Site ID on telemetry server.", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "host", - "siteId" - ], - "type": "object" - }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" + "shadowSpread": { + "format": "double", + "type": "number" }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" + "shadowX": { + "format": "double", + "type": "number" }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - } - ], - "type": "object" - }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", - "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" + "shadowY": { + "format": "double", + "type": "number" }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", + "textColor": { "type": "string" - } - }, - "required": [ - "definition", - "localIdentifier" - ], - "type": "object" - }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonCondition" }, - { - "$ref": "#/components/schemas/RangeCondition" - } - ], - "type": "object" - }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" } - ], + }, "type": "object" }, - "MetricDefinitionOverride": { - "description": "(EXPERIMENTAL) Override for a catalog metric definition.", - "properties": { - "definition": { - "$ref": "#/components/schemas/InlineMeasureDefinition" + "PublisherDocumentContent": { + "description": "Content of a document or a document template. Holds `pages` or `sections`, never both.", + "example": { + "defaults": { + "pageSize": "widescreen", + "takeaway": { + "generation": { + "instructions": "Write for executives. Lead with the change." + } + } }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "filters": [ + { + "attributeFilter": { + "attributeElements": { + "uris": [] + }, + "displayForm": { + "identifier": "brand.name", + "type": "displayForm" + }, + "localIdentifier": "document_filter_brand_name", + "negativeSelection": true, + "title": "Brand" + } + } + ], + "pages": [ + { + "id": "page_7f3a91c4", + "kind": "cover", + "layout": { + "children": [ + { + "id": "coverTitle", + "markdown": "{documentName}", + "proportion": 2, + "style": { + "textColor": "{theme.colors.texts.inverse}" + }, + "type": "title" + }, + { + "id": "coverSubtitle", + "markdown": "{documentDateRange}", + "style": { + "textColor": "{theme.colors.texts.inverse}", + "textStyle": "h3" + }, + "type": "text" + } + ], + "type": "column" + }, + "style": { + "backgroundColor": "{theme.colors.backgrounds.inverse}", + "backgroundImage": "{theme.coverImage}", + "backgroundImageOpacity": 0.35 + } + }, + { + "id": "page_c41d9a07", + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "markdown": "Revenue grew **12 %** in {documentDateRange}", + "proportion": 2, + "type": "title" + }, + { + "children": [ + { + "dateDataSet": { + "identifier": "date", + "type": "dataSet" + }, + "id": "widget1", + "proportion": 2, + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "borderRadius": "{theme.corners.medium}", + "padding": 24 + }, + "title": { + "visible": true + }, + "type": "visualization", + "visualization": { + "identifier": "revenue_by_month", + "type": "insight" + } + }, + { + "generation": { + "context": { + "widgets": [ + "widget1" + ] + } + }, + "id": "takeaway", + "markdown": "Revenue grew in every region, led by EMEA at +18 %.", + "style": { + "backgroundColor": "{theme.colors.backgrounds.accent}", + "backgroundOpacity": 0.08, + "borderLeftColor": "{theme.colors.lines.accent}", + "borderLeftWidth": 8, + "padding": 32 + }, + "title": { + "text": "Key takeaway" + }, + "type": "takeaway" + } + ], + "proportion": 9, + "type": "row" + } + ], + "style": { + "gap": "{theme.spacing.gap.normal}" + }, + "type": "column" + }, + "notes": "Mention the EMEA promotion." + }, + { + "id": "page_3c19e0b7", + "kind": "content", + "layout": { + "id": "appendix", + "markdown": "Methodology notes for reviewers.", + "type": "text" + }, + "visible": false + } + ], + "style": { + "backgroundColor": "{theme.colors.backgrounds.surface}", + "gap": 28 } }, - "required": [ - "definition", - "item" - ], - "type": "object" - }, - "MetricPermissions": { "properties": { - "rules": { - "description": "List of rules", + "attributeFilterConfigs": { "items": { - "$ref": "#/components/schemas/RulePermission" + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterConfig" }, "type": "array" }, - "userGroups": { - "description": "List of user groups", + "defaults": { + "$ref": "#/components/schemas/PublisherDocumentDefaults" + }, + "filters": { + "description": "Document filters, at most one per attribute display form or date dataset.", "items": { - "$ref": "#/components/schemas/UserGroupPermission" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" }, - "users": { - "description": "List of users", + "formatLocale": { + "description": "Locale for formatting dates in variables, charts and tables.", + "type": "string" + }, + "locale": { + "description": "Locale of the text the product writes, such as `de-DE`.", + "type": "string" + }, + "pages": { + "description": "The document's pages, when it has no sections.", "items": { - "$ref": "#/components/schemas/UserPermission" + "$ref": "#/components/schemas/PublisherDocumentPage" }, "type": "array" - } - }, - "required": [ - "rules", - "userGroups", - "users" - ], - "type": "object" - }, - "MetricPermissionsAssignment": { - "description": "Desired levels of permissions on a metric for an assignee.", - "properties": { - "permissions": { + }, + "sections": { + "description": "Groups of pages, when the document has no top-level pages.", "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/PublisherDocumentSection" }, "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "MetricPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } - }, - "type": "object" + "style": { + "$ref": "#/components/schemas/PublisherDocumentAreaStyle" } - ], - "description": "Desired levels of metric permissions for an assignee identified by an identifier.", - "required": [ - "assigneeIdentifier", - "permissions" - ], + }, "type": "object" }, - "MetricPermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "PublisherDocumentDataSetRef": { + "description": "A date dataset.", + "properties": { + "identifier": { + "type": "string" }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" + "type": { + "enum": [ + "dataSet" + ], + "type": "string" } - ], - "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", + }, "required": [ - "assigneeRule", - "permissions" + "identifier", + "type" ], "type": "object" }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", + "PublisherDocumentDateFilter": { + "description": "Filters a date dataset. A document filter always names its `dataSet`.", "properties": { - "negativeAttributeFilter": { + "dateFilter": { "properties": { - "applyOnResult": { - "type": "boolean" + "attribute": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "boundedFilter": { + "$ref": "#/components/schemas/PublisherDocumentBoundedFilter" + }, + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "emptyValueHandling": { + "enum": [ + "include", + "exclude", + "only" + ], + "type": "string" + }, + "from": { + "description": "A date, or an offset of a relative filter.", + "oneOf": [ + { + "type": "string" + }, + { + "format": "double", + "type": "number" + } + ] + }, + "granularity": { + "enum": [ + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" + ], + "type": "string" }, "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" + "to": { + "description": "A date, or an offset of a relative filter.", + "oneOf": [ + { + "type": "string" + }, + { + "format": "double", + "type": "number" + } + ] }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + "type": { + "enum": [ + "relative", + "absolute" + ], + "type": "string" } }, "required": [ - "label", - "notIn" + "granularity", + "type" ], "type": "object" } }, "required": [ - "negativeAttributeFilter" + "dateFilter" ], "type": "object" }, - "Note": { + "PublisherDocumentDateFilterReference": { "properties": { - "appliesTo": { + "dataSet": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": { "enum": [ - "SOURCE", - "TARGET" + "dateFilterReference" ], - "type": "string", - "xml": { - "attribute": true - } - }, - "category": { - "type": "string", - "xml": { - "attribute": true - } - }, - "content": { "type": "string" - }, - "id": { - "type": "string", - "xml": { - "attribute": true - } - }, - "otherAttributes": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "priority": { - "format": "int32", - "type": "integer", - "xml": { - "attribute": true - } } }, - "type": "object", - "xml": { - "name": "note", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } + "required": [ + "dataSet", + "type" + ], + "type": "object" }, - "Notes": { + "PublisherDocumentDefaults": { + "description": "Document-wide defaults.", "properties": { - "note": { - "items": { - "$ref": "#/components/schemas/Note" - }, - "type": "array" + "pageSize": { + "description": "Page size of a page that sets none.", + "enum": [ + "widescreen" + ], + "type": "string" + }, + "period": { + "$ref": "#/components/schemas/PublisherDocumentPeriod" + }, + "takeaway": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayDefaults" } }, - "required": [ - "note" - ], - "type": "object", - "xml": { - "name": "notes", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } + "type": "object" }, - "NotificationChannelDestination": { + "PublisherDocumentFilter": { + "description": "A filter in the dashboard filter grammar, wrapped in an object keyed by its kind.", "oneOf": [ { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/PublisherDocumentAttributeFilter" }, { - "$ref": "#/components/schemas/Smtp" + "$ref": "#/components/schemas/PublisherDocumentArbitraryAttributeFilter" }, { - "$ref": "#/components/schemas/DefaultSmtp" + "$ref": "#/components/schemas/PublisherDocumentMatchAttributeFilter" }, { - "$ref": "#/components/schemas/InPlatform" + "$ref": "#/components/schemas/PublisherDocumentDateFilter" + }, + { + "$ref": "#/components/schemas/PublisherDocumentMeasureValueFilter" } ], "type": "object" }, - "NumberConstraints": { + "PublisherDocumentFilterReference": { + "description": "A reference to a document filter, selected by `type`.", + "discriminator": { + "mapping": { + "attributeFilterReference": "#/components/schemas/PublisherDocumentAttributeFilterReference", + "dateFilterReference": "#/components/schemas/PublisherDocumentDateFilterReference", + "measureValueFilterReference": "#/components/schemas/PublisherDocumentMeasureValueFilterReference" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/PublisherDocumentAttributeFilterReference" + }, + { + "$ref": "#/components/schemas/PublisherDocumentDateFilterReference" + }, + { + "$ref": "#/components/schemas/PublisherDocumentMeasureValueFilterReference" + } + ], + "type": "object" + }, + "PublisherDocumentHeadingWidget": { + "description": "A heading below the page title.", "properties": { - "max": { + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "level": { + "description": "Outline level below the page title. Default 1.", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6 + ], + "format": "int32", + "type": "integer" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Inline markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, "format": "double", + "minimum": 0, "type": "number" }, - "min": { + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { + "enum": [ + "heading" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "PublisherDocumentHeadlineStyle": { + "description": "Headline style overrides; stored, not applied. Lengths are in canvas px.", + "properties": { + "negativeColor": { + "type": "string" + }, + "positiveColor": { + "type": "string" + }, + "primaryValueColor": { + "type": "string" + }, + "primaryValueSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "secondaryValueColor": { + "type": "string" + }, + "secondaryValueSize": { "format": "double", + "minimum": 0, "type": "number" } }, "type": "object" }, - "NumberParameterDefinition": { + "PublisherDocumentImageWidget": { + "description": "An image from the theme or an https URL.", "properties": { - "constraints": { - "$ref": "#/components/schemas/NumberConstraints" + "altText": { + "type": "string" }, - "defaultValue": { + "decorative": { + "description": "Left out of the accessibility tree, PDF tags and the AI context; needs no alt text.", + "type": "boolean" + }, + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, "format": "double", + "minimum": 0, "type": "number" }, + "source": { + "description": "A theme image reference such as `{theme.logo}`, or an `https://` URL.", + "example": "{theme.logo}", + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentImageWidgetStyle" + }, "type": { - "description": "The parameter type.", "enum": [ - "NUMBER" + "image" ], "type": "string" } }, "required": [ - "defaultValue", + "id", "type" ], "type": "object" }, - "ObjectConditionalFormatting": { - "description": "Conditional formatting inherited by every table column that renders this object.", - "nullable": true, + "PublisherDocumentImageWidgetStyle": { + "description": "Style of an image widget. Lengths are in canvas px.", "properties": { - "conditions": { - "description": "Conditions evaluated in order; the first match wins.", - "items": { - "$ref": "#/components/schemas/ConditionalFormattingCondition" - }, - "type": "array" + "backgroundColor": { + "type": "string" }, - "enabled": { - "description": "Whether the conditions are applied when rendering.", - "type": "boolean" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fit": { + "enum": [ + "contain", + "cover", + "fill" + ], + "type": "string" + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { + "type": "string" + }, + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { + "type": "string" + }, + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" } }, - "required": [ - "conditions", - "enabled" - ], "type": "object" }, - "ObjectLinks": { - "properties": { - "self": { - "description": "A string containing the link's URL.", - "format": "uri", - "type": "string" + "PublisherDocumentLayoutNode": { + "description": "A layout node: a row or column container, or a widget. The shape is selected by `type`.", + "discriminator": { + "mapping": { + "column": "#/components/schemas/PublisherDocumentColumn", + "heading": "#/components/schemas/PublisherDocumentHeadingWidget", + "image": "#/components/schemas/PublisherDocumentImageWidget", + "row": "#/components/schemas/PublisherDocumentRow", + "takeaway": "#/components/schemas/PublisherDocumentTakeawayWidget", + "text": "#/components/schemas/PublisherDocumentTextWidget", + "title": "#/components/schemas/PublisherDocumentTitleWidget", + "visualization": "#/components/schemas/PublisherDocumentVisualizationWidget" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/PublisherDocumentRow" + }, + { + "$ref": "#/components/schemas/PublisherDocumentColumn" + }, + { + "$ref": "#/components/schemas/PublisherDocumentTitleWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentHeadingWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentTextWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentImageWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentVisualizationWidget" + }, + { + "$ref": "#/components/schemas/PublisherDocumentTakeawayWidget" } - }, - "required": [ - "self" ], "type": "object" }, - "ObjectLinksContainer": { - "properties": { - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "type": "object" - }, - "OpenAIProviderConfig": { - "description": "Configuration for OpenAI provider.", + "PublisherDocumentLegendDisplay": { "properties": { - "auth": { - "$ref": "#/components/schemas/OpenAiProviderAuth" - }, - "baseUrl": { - "default": "https://api.openai.com/v1", - "description": "Custom base URL for OpenAI API.", - "maxLength": 255, - "type": "string" - }, - "organization": { - "description": "OpenAI organization ID.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "type": { - "description": "Provider type.", + "position": { "enum": [ - "OPENAI" + "auto", + "top", + "bottom", + "left", + "right" ], "type": "string" + }, + "visible": { + "type": "boolean" } }, - "required": [ - "auth", - "type" - ], "type": "object" }, - "OpenAiApiKeyAuth": { - "allOf": [ - { + "PublisherDocumentMatchAttributeFilter": { + "description": "Filters an attribute display form by a text pattern.", + "properties": { + "matchAttributeFilter": { "properties": { - "apiKey": { - "description": "OpenAI API key.", - "maxLength": 255, - "nullable": true, - "type": "string", - "writeOnly": true + "caseSensitive": { + "type": "boolean" }, - "type": { - "description": "Authentication type.", + "displayForm": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "literal": { + "type": "string" + }, + "localIdentifier": { + "description": "Required on a document filter in the declarative layout. A REST write can omit it there. The server then generates it. Optional on a page filter.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "negativeSelection": { + "type": "boolean" + }, + "operator": { "enum": [ - "API_KEY" + "contains", + "startsWith", + "endsWith" ], "type": "string" + }, + "title": { + "type": "string" } }, + "required": [ + "displayForm", + "literal", + "operator" + ], "type": "object" } - ], + }, "required": [ - "type" + "matchAttributeFilter" ], "type": "object" }, - "OpenAiProviderAuth": { - "description": "Authentication configuration.", + "PublisherDocumentMeasureValueCondition": { + "description": "A measure value condition, wrapped in an object keyed by its kind.", "oneOf": [ { - "$ref": "#/components/schemas/OpenAiApiKeyAuth" + "$ref": "#/components/schemas/PublisherDocumentComparisonCondition" + }, + { + "$ref": "#/components/schemas/PublisherDocumentRangeCondition" } ], "type": "object" }, - "OpenTelemetryService": { - "description": "OpenTelemetry service.", + "PublisherDocumentMeasureValueFilter": { + "description": "Filters by the value of a measure.", "properties": { - "host": { - "description": "Telemetry host to send events to.", - "type": "string" + "dashboardMeasureValueFilter": { + "properties": { + "conditions": { + "description": "OR-ed conditions; none means all values.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentMeasureValueCondition" + }, + "type": "array" + }, + "dimensionality": { + "items": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "type": "array" + }, + "localIdentifier": { + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "measure": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" + }, + "title": { + "type": "string" + } + }, + "required": [ + "localIdentifier", + "measure" + ], + "type": "object" } }, "required": [ - "host" + "dashboardMeasureValueFilter" ], "type": "object" }, - "OrganizationAutomationIdentifier": { + "PublisherDocumentMeasureValueFilterReference": { "properties": { - "id": { - "type": "string" + "measure": { + "$ref": "#/components/schemas/PublisherDocumentObjRef" }, - "workspaceId": { + "type": { + "enum": [ + "measureValueFilterReference" + ], "type": "string" } }, "required": [ - "id", - "workspaceId" - ], - "type": "object" - }, - "OrganizationAutomationManagementBulkRequest": { - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/OrganizationAutomationIdentifier" - }, - "type": "array" - } - }, - "required": [ - "automations" + "measure", + "type" ], "type": "object" }, - "OrganizationPermissionAssignment": { - "description": "Organization permission assignments", + "PublisherDocumentObjRef": { + "description": "A flat object reference.", "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "identifier": { + "type": "string" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" - }, - "type": "array" + "type": { + "description": "sdk-model object type, such as `displayForm`, `dataSet` or `measure`.", + "type": "string" } }, "required": [ - "assigneeIdentifier", - "permissions" + "identifier", + "type" ], "type": "object" }, - "Over": { + "PublisherDocumentPage": { + "description": "A page of a document.", "properties": { - "attributes": { + "filters": { + "description": "Page filters; stored, not applied.", "items": { - "$ref": "#/components/schemas/IdentifierRef" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" + }, + "id": { + "description": "Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], + "type": "string" + }, + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", + "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" + }, + "visible": { + "description": "`false` keeps the page out of the viewer, exports and page numbering. Default `true`.", + "type": "boolean" } }, "required": [ - "attributes" + "layout" ], "type": "object" }, - "PageMetadata": { + "PublisherDocumentPageStyle": { + "description": "Style of a page; containers inherit its gap and text keys. Lengths are in canvas px.", "properties": { - "number": { - "description": "The number of the current page", - "format": "int32", - "type": "integer" + "backgroundColor": { + "type": "string" }, - "size": { - "description": "The size of the current page", - "format": "int32", - "type": "integer" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" }, - "totalElements": { - "description": "The total number of elements", - "format": "int32", - "type": "integer" + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" }, - "totalPages": { - "description": "The total number of pages", - "format": "int32", - "type": "integer" + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "gap": { + "description": "A length, or `{theme.spacing.gap.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "textColor": { + "type": "string" + }, + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" + }, + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" + }, + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" } }, "type": "object" }, - "Parameter": { + "PublisherDocumentPageTemplateContent": { + "description": "Content of a page template: one page without `id` and `visible`.", + "example": { + "kind": "content", + "layout": { + "children": [ + { + "id": "pageTitle", + "placeholder": { + "hint": "Page title" + }, + "proportion": 2, + "style": { + "textStyle": "title" + }, + "type": "title" + }, + { + "children": [ + { + "children": [ + { + "id": "widget1", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" + }, + { + "id": "widget2", + "placeholder": { + "hint": "Add a visualization" + }, + "title": { + "visible": true + }, + "type": "visualization" + } + ], + "proportion": 2, + "type": "row" + }, + { + "id": "summary", + "placeholder": { + "hint": "Add a summary" + }, + "proportion": 1, + "style": { + "textStyle": "normalText" + }, + "type": "text" + } + ], + "proportion": 9, + "type": "row" + }, + { + "children": [ + { + "decorative": true, + "id": "footerLogo", + "proportion": 1, + "source": "{theme.logo}", + "style": { + "fit": "contain", + "horizontalAlign": "left", + "verticalAlign": "bottom" + }, + "type": "image" + }, + { + "decorative": true, + "id": "footerPageNumber", + "markdown": "{currentPageNumber} / {totalPages}", + "proportion": 8, + "style": { + "horizontalAlign": "right", + "textStyle": "largeText", + "verticalAlign": "bottom" + }, + "type": "text" + } + ], + "proportion": 1, + "type": "row" + } + ], + "type": "column" + } + }, "properties": { - "name": { + "filters": { + "description": "Page filters; stored, not applied.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilter" + }, + "type": "array" + }, + "kind": { + "description": "Editor hint.", + "enum": [ + "cover", + "section", + "content" + ], "type": "string" }, - "value": { + "layout": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "notes": { + "description": "Speaker notes in markdown, never drawn.", "type": "string" + }, + "pageSize": { + "enum": [ + "widescreen" + ], + "type": "string" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentPageStyle" } }, "required": [ - "name", - "value" + "layout" ], "type": "object" }, - "ParameterDefinition": { - "description": "Parameter content (type-discriminated).", + "PublisherDocumentPeriod": { + "description": "The period the document covers, absolute or relative to today.", "discriminator": { "mapping": { - "NUMBER": "#/components/schemas/NumberParameterDefinition", - "STRING": "#/components/schemas/StringParameterDefinition" + "absolute": "#/components/schemas/AbsolutePublisherDocumentPeriod", + "relative": "#/components/schemas/RelativePublisherDocumentPeriod" }, "propertyName": "type" }, "oneOf": [ { - "$ref": "#/components/schemas/NumberParameterDefinition" + "$ref": "#/components/schemas/AbsolutePublisherDocumentPeriod" }, { - "$ref": "#/components/schemas/StringParameterDefinition" + "$ref": "#/components/schemas/RelativePublisherDocumentPeriod" } ], "type": "object" }, - "ParameterItem": { - "additionalProperties": true, - "description": "(EXPERIMENTAL) Parameter value for this execution.", + "PublisherDocumentRangeCondition": { "properties": { - "parameter": { - "$ref": "#/components/schemas/AfmObjectIdentifierParameter" - }, - "value": { - "description": "Value to use for this parameter instead of its default.", - "type": "string" + "range": { + "properties": { + "from": { + "format": "double", + "type": "number" + }, + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + }, + "treatNullValuesAs": { + "format": "double", + "type": "number" + } + }, + "required": [ + "from", + "operator", + "to" + ], + "type": "object" } }, "required": [ - "parameter", - "value" + "range" ], "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.", + "PublisherDocumentRow": { + "description": "Lays its children out left to right.", "properties": { + "children": { + "description": "Child nodes from left to right, in reading order; an empty list is a spacer.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentLayoutNode" + }, + "type": "array" + }, "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" + "locked": { + "description": "Locks the container in the document editor; never checked on write.", + "type": "boolean" }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" + "proportion": { + "description": "Share of the parent's main axis, greater than 0. Default 1.", + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" }, - "valueTitle": { - "description": "Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.", - "example": "year 2026", - "type": "string" - } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" - }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } + "style": { + "$ref": "#/components/schemas/PublisherDocumentContainerStyle" + }, + "type": { + "enum": [ + "row" ], - "selector": "th" + "type": "string" } + }, + "required": [ + "children", + "type" ], + "type": "object" + }, + "PublisherDocumentSection": { + "description": "A group of pages, like a dashboard tab.", "properties": { - "properties": { - "description": "List of CSS properties.", + "description": { + "type": "string" + }, + "id": { + "description": "Unique within the document. Required in the declarative layout. A REST write can omit it. The server then generates it.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "pages": { "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" + "$ref": "#/components/schemas/PublisherDocumentPage" }, "type": "array" }, - "selector": { - "description": "CSS selector where to apply given properties.", + "title": { "type": "string" } }, "required": [ - "selector" + "pages" ], "type": "object" }, - "PdfTableStyleProperty": { - "description": "CSS property.", + "PublisherDocumentTableStyle": { + "description": "Table style overrides; stored, not applied. Lengths are in canvas px.", "properties": { - "key": { - "description": "CSS property key.", + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "gridColor": { "type": "string" }, - "value": { - "description": "CSS property value.", + "headerBackgroundColor": { + "type": "string" + }, + "headerLabelColor": { + "type": "string" + }, + "nullValueColor": { + "type": "string" + }, + "rowHeight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "subtotalBackgroundColor": { + "type": "string" + }, + "totalBackgroundColor": { + "type": "string" + }, + "totalValueColor": { + "type": "string" + }, + "valueColor": { "type": "string" } }, - "required": [ - "key", - "value" - ], "type": "object" }, - "PdmLdmRequest": { - "description": "PDM additions wrapper.", + "PublisherDocumentTakeawayContext": { + "description": "What the copilot reads when it writes a takeaway.", "properties": { - "sqls": { - "description": "List of SQL datasets.", - "items": { - "$ref": "#/components/schemas/PdmSql" - }, - "type": "array" + "filters": { + "type": "boolean" }, - "tableOverrides": { - "description": "(BETA) List of table overrides.", - "items": { - "$ref": "#/components/schemas/TableOverride" - }, - "type": "array" + "otherPages": { + "type": "boolean" }, - "tables": { - "description": "List of physical database tables.", + "pageTitle": { + "type": "boolean" + }, + "widgets": { + "description": "Widget ids on the same page.", "items": { - "$ref": "#/components/schemas/DeclarativeTable" + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" }, "type": "array" } }, "type": "object" }, - "PdmSql": { - "description": "SQL dataset definition.", + "PublisherDocumentTakeawayDefaults": { + "description": "Takeaway settings every takeaway widget of the document uses.", "properties": { - "columns": { - "description": "Columns defining SQL dataset.", - "items": { - "$ref": "#/components/schemas/SqlColumn" - }, - "type": "array" + "generation": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayGeneration" + } + }, + "type": "object" + }, + "PublisherDocumentTakeawayGeneration": { + "description": "How the copilot writes a takeaway.", + "properties": { + "context": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayContext" }, - "statement": { - "description": "SQL statement.", - "example": "select * from abc", + "instructions": { + "type": "string" + } + }, + "type": "object" + }, + "PublisherDocumentTakeawayWidget": { + "description": "A generated takeaway, stored as markdown.", + "properties": { + "generation": { + "$ref": "#/components/schemas/PublisherDocumentTakeawayGeneration" + }, + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "The generated text.", "type": "string" }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, "title": { - "description": "SQL dataset title.", - "example": "My special dataset", + "$ref": "#/components/schemas/PublisherDocumentWidgetTitle" + }, + "type": { + "enum": [ + "takeaway" + ], "type": "string" } }, "required": [ - "statement", - "title" + "id", + "type" ], "type": "object" }, - "PermissionsAssignment": { + "PublisherDocumentTextStyle": { + "description": "Text style of a widget title. Lengths are in canvas px.", "properties": { - "assignees": { - "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "minItems": 1, - "type": "array" + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" }, - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "textColor": { + "type": "string" + }, + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" + }, + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" + }, + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" } }, - "required": [ - "assignees" - ], "type": "object" }, - "PermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + "PublisherDocumentTextWidget": { + "description": "A block of markdown text.", + "properties": { + "decorative": { + "description": "Left out of the accessibility tree, PDF tags and the AI context.", + "type": "boolean" }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } - }, - "type": "object" + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Full markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { + "enum": [ + "text" + ], + "type": "string" } - ], - "description": "Desired levels of permissions for an assignee identified by an identifier.", + }, "required": [ - "assigneeIdentifier", - "permissions" + "id", + "type" ], "type": "object" }, - "PermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + "PublisherDocumentTextWidgetStyle": { + "description": "Style of a title, heading, text or takeaway widget. Lengths are in canvas px.", + "properties": { + "backgroundColor": { + "type": "string" }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" } - }, - "type": "object" + ] + }, + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontSize": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "fontStyle": { + "enum": [ + "normal", + "italic" + ], + "type": "string" + }, + "fontWeight": { + "format": "double", + "maximum": 1000, + "minimum": 1, + "type": "number" + }, + "horizontalAlign": { + "enum": [ + "left", + "center", + "right", + "justify" + ], + "type": "string" + }, + "letterSpacing": { + "format": "double", + "type": "number" + }, + "lineHeight": { + "format": "double", + "type": "number" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { + "type": "string" + }, + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { + "type": "string" + }, + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "textColor": { + "type": "string" + }, + "textOverflow": { + "enum": [ + "shrink", + "clip", + "ellipsis" + ], + "type": "string" + }, + "textStyle": { + "enum": [ + "title", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "largeText", + "normalText", + "smallText" + ], + "type": "string" + }, + "textTransform": { + "enum": [ + "none", + "uppercase", + "lowercase", + "capitalize" + ], + "type": "string" + }, + "verticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" } - ], - "description": "Desired levels of permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], + }, "type": "object" }, - "PlatformUsage": { + "PublisherDocumentTitleWidget": { + "description": "The page's title, at most one per page.", "properties": { - "count": { - "format": "int32", - "type": "integer" + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "markdown": { + "description": "Inline markdown.", + "type": "string" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" }, - "name": { + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextWidgetStyle" + }, + "type": { "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" + "title" ], "type": "string" } }, "required": [ - "name" + "id", + "type" ], "type": "object" }, - "PlatformUsageRequest": { + "PublisherDocumentVisibility": { "properties": { - "usageItemNames": { - "items": { - "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "visible": { + "type": "boolean" } }, - "required": [ - "usageItemNames" - ], "type": "object" }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "PublisherDocumentVisualizationDisplay": { + "description": "Overrides of the saved visualization's own configuration; stored, not applied.", "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + "dataLabels": { + "$ref": "#/components/schemas/PublisherDocumentAutoVisibility" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "dataPoints": { + "$ref": "#/components/schemas/PublisherDocumentAutoVisibility" + }, + "gridlines": { + "$ref": "#/components/schemas/PublisherDocumentVisibility" + }, + "legend": { + "$ref": "#/components/schemas/PublisherDocumentLegendDisplay" + }, + "secondaryYAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" + }, + "xAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" + }, + "yAxis": { + "$ref": "#/components/schemas/PublisherDocumentAxisDisplay" } }, - "required": [ - "dataset", - "periodsAgo" - ], "type": "object" }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", + "PublisherDocumentVisualizationRef": { + "description": "A saved visualization.", "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - }, - "required": [ - "dateDatasets", - "measureIdentifier" + "identifier": { + "type": "string" + }, + "type": { + "enum": [ + "insight" ], - "type": "object" + "type": "string" } }, "required": [ - "previousPeriodMeasure" + "identifier", + "type" ], "type": "object" }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "PublisherDocumentVisualizationStyle": { + "description": "Style of a visualization widget. Lengths are in canvas px.", "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" + "backgroundColor": { + "type": "string" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "attribute", - "periodsAgo" - ], - "type": "object" - }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", - "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" - }, - "type": "array" + "backgroundFit": { + "enum": [ + "cover", + "contain", + "fill", + "tile" + ], + "type": "string" + }, + "backgroundHorizontalAlign": { + "enum": [ + "left", + "center", + "right" + ], + "type": "string" + }, + "backgroundImage": { + "type": "string" + }, + "backgroundImageOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundOffset": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetBottom": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetLeft": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetRight": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOffsetTop": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "backgroundOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "backgroundVerticalAlign": { + "enum": [ + "top", + "center", + "bottom" + ], + "type": "string" + }, + "borderBottomColor": { + "type": "string" + }, + "borderBottomLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + { + "type": "string" } - }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" - }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" + ] }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - } - ], - "type": "object" - }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "borderBottomRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" + { + "type": "string" + } + ] + }, + "borderBottomStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderBottomWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderColor": { + "type": "string" + }, + "borderLeftColor": { + "type": "string" + }, + "borderLeftStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderLeftWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + { + "type": "string" + } + ] + }, + "borderRightColor": { + "type": "string" + }, + "borderRightStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderRightWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" + ], + "type": "string" + }, + "borderTopColor": { + "type": "string" + }, + "borderTopLeftRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "localIdentifier": { + { "type": "string" + } + ] + }, + "borderTopRightRadius": { + "description": "A length, or `{theme.corners.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + { + "type": "string" } - }, - "required": [ - "in", - "label" + ] + }, + "borderTopStyle": { + "enum": [ + "solid", + "dashed", + "dotted", + "none" ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "Profile": { - "properties": { - "entitlements": { - "description": "Defines entitlements for given organization.", - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" + "type": "string" }, - "features": { + "borderTopWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "borderWidth": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "chart": { + "$ref": "#/components/schemas/PublisherDocumentChartStyle" + }, + "headline": { + "$ref": "#/components/schemas/PublisherDocumentHeadlineStyle" + }, + "opacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "padding": { + "description": "A length, or `{theme.spacing.padding.}`.", "oneOf": [ { - "$ref": "#/components/schemas/LiveFeatures" + "format": "double", + "type": "number" }, { - "$ref": "#/components/schemas/StaticFeatures" + "type": "string" } ] }, - "links": { - "$ref": "#/components/schemas/ProfileLinks" + "paddingBottom": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] }, - "name": { + "paddingLeft": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingRight": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "paddingTop": { + "description": "A length, or `{theme.spacing.padding.}`.", + "oneOf": [ + { + "format": "double", + "type": "number" + }, + { + "type": "string" + } + ] + }, + "shadow": { "type": "string" }, - "organizationId": { + "shadowBlur": { + "format": "double", + "minimum": 0, + "type": "number" + }, + "shadowColor": { "type": "string" }, - "organizationName": { + "shadowOpacity": { + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shadowSpread": { + "format": "double", + "type": "number" + }, + "shadowX": { + "format": "double", + "type": "number" + }, + "shadowY": { + "format": "double", + "type": "number" + }, + "table": { + "$ref": "#/components/schemas/PublisherDocumentTableStyle" + } + }, + "type": "object" + }, + "PublisherDocumentVisualizationWidget": { + "description": "A saved visualization.", + "properties": { + "altText": { + "description": "Defaults to the visualization's description.", "type": "string" }, - "permissions": { + "dateDataSet": { + "$ref": "#/components/schemas/PublisherDocumentDataSetRef" + }, + "display": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationDisplay" + }, + "filters": { + "description": "Widget filters; stored, not applied.", "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" + "$ref": "#/components/schemas/PublisherDocumentFilter" }, "type": "array" }, - "telemetryConfig": { - "$ref": "#/components/schemas/TelemetryConfig" + "id": { + "description": "Unique within the page.", + "pattern": "^[A-Za-z0-9_.-]{1,64}$", + "type": "string" }, - "userId": { + "ignoreDocumentFilters": { + "description": "Document filters this widget ignores.", + "items": { + "$ref": "#/components/schemas/PublisherDocumentFilterReference" + }, + "type": "array" + }, + "ignoreDocumentPeriod": { + "type": "boolean" + }, + "locked": { + "description": "Locks the widget in the document editor; never checked on write.", + "type": "boolean" + }, + "placeholder": { + "$ref": "#/components/schemas/PublisherDocumentWidgetPlaceholder" + }, + "proportion": { + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" + }, + "style": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationStyle" + }, + "title": { + "$ref": "#/components/schemas/PublisherDocumentWidgetTitle" + }, + "type": { + "enum": [ + "visualization" + ], "type": "string" + }, + "visualization": { + "$ref": "#/components/schemas/PublisherDocumentVisualizationRef" } }, "required": [ - "entitlements", - "features", - "links", - "organizationId", - "organizationName", - "permissions", - "telemetryConfig", - "userId" + "id", + "type" ], "type": "object" }, - "ProfileLinks": { + "PublisherDocumentWidgetPlaceholder": { + "description": "What the editor shows in an empty widget.", "properties": { - "organization": { + "hint": { "type": "string" }, - "self": { - "type": "string" + "required": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublisherDocumentWidgetTitle": { + "description": "Title of a visualization or takeaway widget.", + "properties": { + "style": { + "$ref": "#/components/schemas/PublisherDocumentTextStyle" }, - "user": { + "text": { + "description": "Overrides the default title; may contain text variables.", "type": "string" + }, + "visible": { + "description": "Default `true`.", + "type": "boolean" } }, - "required": [ - "organization", - "self", - "user" - ], "type": "object" }, "Range": { @@ -36391,6 +44311,68 @@ ], "type": "object" }, + "RelativePublisherDocumentPeriod": { + "allOf": [ + { + "properties": { + "from": { + "description": "Start of the period, in units relative to the current one.", + "example": -1, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Date granularity of the period.", + "enum": [ + "GDC.time.second", + "GDC.time.minute", + "GDC.time.hour", + "GDC.time.date", + "GDC.time.week_us", + "GDC.time.month", + "GDC.time.fiscal_month", + "GDC.time.quarter", + "GDC.time.fiscal_quarter", + "GDC.time.year", + "GDC.time.fiscal_year" + ], + "example": "GDC.time.month", + "type": "string" + }, + "to": { + "description": "End of the period, in units relative to the current one.", + "example": -1, + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Type of the period.", + "enum": [ + "relative" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A period counted in granularity units from the current one, which is 0.", + "properties": { + "type": { + "enum": [ + "relative" + ], + "type": "string" + } + }, + "required": [ + "from", + "granularity", + "to", + "type" + ], + "type": "object" + }, "RelativeWrapper": { "properties": { "relative": { @@ -38137,6 +46119,24 @@ ], "type": "object" }, + "WorkspaceLocalizationUsage": { + "properties": { + "settings": { + "$ref": "#/components/schemas/LocalizationResolvedValues" + }, + "values": { + "items": { + "$ref": "#/components/schemas/LocalizationUsageValue" + }, + "type": "array" + } + }, + "required": [ + "settings", + "values" + ], + "type": "object" + }, "WorkspacePermissionAssignment": { "description": "Workspace permission assignments", "properties": { @@ -38779,6 +46779,282 @@ ] } }, + "/api/v1/actions/organization/localization/statistics": { + "get": { + "description": "(BETA) Lists the languages that have at least one translation, separately for each kind of translation.", + "operationId": "organizationLocalizationStatistics", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationStatistics" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages with translations in the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage": { + "get": { + "description": "(BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves count. `defaults` holds the value a workspace gets when it and its parents set nothing.", + "operationId": "organizationLocalizationUsage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsage" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages used in the organization.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage/users": { + "get": { + "description": "(BETA) Lists the users behind the counts of the organization localization usage, sorted by name. Users without a name come last. Users count under the value they get in the organization. That value depends on the workspace, so only the settings that users set themselves match. Only the source USER returns users. Without the setting filter, a user matches when any of the display, metadata and data language settings matches. Users counted in the usage entry without a language are not listed.", + "operationId": "organizationLocalizationUsageUsers", + "parameters": [ + { + "description": "Language tag that the user sets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "ito", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "USER", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageUsers" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Users who set a language themselves.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/localization/usage/workspaces": { + "get": { + "description": "(BETA) Lists the workspaces behind the counts of the organization localization usage, sorted by name. Without the setting filter, a workspace matches when any of the display, metadata and data language settings matches, and its source is the strongest one.", + "operationId": "organizationLocalizationUsageWorkspaces", + "parameters": [ + { + "description": "Language tag that the workspace gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by workspace name. Note that the filter is case insensitive.", + "example": "berg", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "PARENT", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageWorkspaces" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspaces that use a language.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/organization/managePermissions": { "post": { "description": "Manage Permissions for a Organization", @@ -40542,6 +48818,201 @@ ] } }, + "/api/v1/actions/workspaces/{workspaceId}/localization/statistics": { + "get": { + "description": "(BETA) Lists the languages that have at least one translation in the workspace or its parent workspaces. Each kind of translation has its own list.", + "operationId": "workspaceLocalizationStatistics", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationStatistics" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages with translations in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage": { + "get": { + "description": "(BETA) Returns the value the workspace gets for each of the display, metadata and data language settings. It also counts the workspace members per language. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. Child workspaces are not included.", + "operationId": "workspaceLocalizationUsage", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceLocalizationUsage" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Languages used in the workspace.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/localization/usage/users": { + "get": { + "description": "(BETA) Lists the workspace members behind the counts of the workspace localization usage, sorted by name. Users without a name come last. Members count under the value they get in the workspace: their own setting, otherwise the value of the workspace. So every source can match. Without the setting filter, a member matches when any of the display, metadata and data language settings matches. Its source is then the strongest one.", + "operationId": "workspaceLocalizationUsageUsers", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Language tag that the user gets.", + "example": "de-DE", + "in": "query", + "name": "value", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "ito", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "One of LOCALE, METADATA_LOCALE and DATA_LOCALE.", + "example": "LOCALE", + "in": "query", + "name": "setting", + "required": false, + "schema": { + "enum": [ + "LOCALE", + "METADATA_LOCALE", + "DATA_LOCALE" + ], + "type": "string" + } + }, + { + "description": "Where the value comes from.", + "example": "WORKSPACE", + "in": "query", + "name": "source", + "required": false, + "schema": { + "description": "Where the value comes from, from the strongest source to the weakest: USER - the user set it. WORKSPACE - the workspace sets it. PARENT - the workspace inherits it from a parent workspace. ORGANIZATION - the organization default. ENVIRONMENT - the default set for the whole deployment. DEFAULT - the built-in default.", + "enum": [ + "USER", + "WORKSPACE", + "PARENT", + "ORGANIZATION", + "ENVIRONMENT", + "DEFAULT" + ], + "type": "string" + } + }, + { + "description": "Zero-based page index (0..N)", + "example": 0, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "description": "The size of the page to be returned.", + "example": 20, + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalizationUsageUsers" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Workspace members who get a language.", + "tags": [ + "Localization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { "post": { "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", @@ -47780,162 +56251,643 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "patch": { + "description": "User - represents entity interacting with platform", + "operationId": "patchEntity@Users", + "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": "authenticationId==someString;firstname==someString", + "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": "userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "description": "User - represents entity interacting with platform", + "operationId": "updateEntity@Users", + "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": "authenticationId==someString;firstname==someString", + "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": "userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put User entity", + "tags": [ + "Users - Entity APIs", + "entities", + "user-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/users/{userId}/apiTokens": { + "get": { + "operationId": "getAllEntities@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "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": "bearerToken==someString", + "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/JsonApiApiTokenOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "List all api tokens for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + }, + "post": { + "operationId": "createEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post a new API token for the user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "delete": { + "operationId": "deleteEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete an API Token for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + }, + "get": { + "operationId": "getEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$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": "bearerToken==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get an API Token for a user", + "tags": [ + "API tokens", + "entities", + "api-token-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/customUserApplicationSettings": { + "get": { + "operationId": "getAllEntities@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "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": "applicationName==someString;content==JsonNodeValue", + "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/JsonApiCustomUserApplicationSettingOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "List all custom application settings for a user", + "tags": [ + "User Settings", + "entities", + "custom-user-application-setting-controller" + ] + }, + "post": { + "operationId": "createEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entity", + "summary": "Post a new custom application setting for the user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" + "custom-user-application-setting-controller" + ] + } + }, + "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { + "delete": { + "operationId": "deleteEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/idPathParameter" + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a custom application setting for a user", + "tags": [ + "User Settings", + "entities", + "custom-user-application-setting-controller" + ] }, - "patch": { - "description": "User - represents entity interacting with platform", - "operationId": "patchEntity@Users", + "get": { + "operationId": "getEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$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": "authenticationId==someString;firstname==someString", + "example": "applicationName==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": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch User entity", + "summary": "Get a custom application setting for a user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "put": { - "description": "User - represents entity interacting with platform", - "operationId": "updateEntity@Users", + "operationId": "updateEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$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": "authenticationId==someString;firstname==someString", + "example": "applicationName==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": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } } }, @@ -47946,35 +56898,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put User entity", + "summary": "Put a custom application setting for the user", "tags": [ - "Users - Entity APIs", + "User Settings", "entities", - "user-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] } }, - "/api/v1/entities/users/{userId}/apiTokens": { + "/api/v1/entities/users/{userId}/userSettings": { "get": { - "operationId": "getAllEntities@ApiTokens", + "operationId": "getAllEntities@UserSettings", "parameters": [ { "in": "path", @@ -47986,7 +56932,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": "bearerToken==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -48030,27 +56976,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all api tokens for a user", + "summary": "List all settings for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] }, "post": { - "operationId": "createEntity@ApiTokens", + "operationId": "createEntity@UserSettings", "parameters": [ { "in": "path", @@ -48065,12 +57011,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -48081,29 +57027,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new API token for the user", + "summary": "Post new user settings for the user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] } }, - "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "/api/v1/entities/users/{userId}/userSettings/{id}": { "delete": { - "operationId": "deleteEntity@ApiTokens", + "operationId": "deleteEntity@UserSettings", "parameters": [ { "in": "path", @@ -48122,15 +57068,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an API Token for a user", + "summary": "Delete a setting for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] }, "get": { - "operationId": "getEntity@ApiTokens", + "operationId": "getEntity@UserSettings", "parameters": [ { "in": "path", @@ -48145,7 +57091,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": "bearerToken==someString", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -48158,29 +57104,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an API Token for a user", + "summary": "Get a setting for a user", "tags": [ - "API tokens", + "User Settings", "entities", - "api-token-controller" + "user-setting-controller" ] - } - }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings": { - "get": { - "operationId": "getAllEntities@CustomUserApplicationSettings", + }, + "put": { + "operationId": "updateEntity@UserSettings", "parameters": [ { "in": "path", @@ -48190,15 +57134,93 @@ "type": "string" } }, + { + "$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/JsonApiUserSettingInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put new user settings for the user", + "tags": [ + "User Settings", + "entities", + "user-setting-controller" + ] + } + }, + "/api/v1/entities/workspaces": { + "get": { + "description": "Space of the shared interest", + "operationId": "getAllEntities@Workspaces", + "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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -48210,7 +57232,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48219,6 +57241,10 @@ "description": "Included meta objects", "items": { "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", "page", "all", "ALL" @@ -48236,47 +57262,91 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all custom application settings for a user", + "summary": "Get Workspace entities", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "operationId": "createEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "createEntity@Workspaces", "parameters": [ { - "in": "path", - "name": "userId", - "required": true, + "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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -48287,136 +57357,280 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new custom application setting for the user", + "summary": "Post Workspace entities", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { + "/api/v1/entities/workspaces/{id}": { "delete": { - "operationId": "deleteEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "deleteEntity@Workspaces", "parameters": [ { - "in": "path", - "name": "userId", - "required": true, + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Workspace entity", + "tags": [ + "Workspaces - Entity APIs", + "entities", + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "description": "Space of the shared interest", + "operationId": "getEntity@Workspaces", + "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": "name==someString;earlyAccess==someString;parent.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { - "204": { - "$ref": "#/components/responses/Deleted" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Delete a custom application setting for a user", + "summary": "Get Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "get": { - "operationId": "getEntity@CustomUserApplicationSettings", + "patch": { + "description": "Space of the shared interest", + "operationId": "patchEntity@Workspaces", "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, { "$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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a custom application setting for a user", + "summary": "Patch Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { - "operationId": "updateEntity@CustomUserApplicationSettings", + "description": "Space of the shared interest", + "operationId": "updateEntity@Workspaces", "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, { "$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": "applicationName==someString;content==JsonNodeValue", + "example": "name==someString;earlyAccess==someString;parent.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": "parent", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "workspaces", + "parent", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -48427,47 +57641,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a custom application setting for the user", + "summary": "Put Workspace entity", "tags": [ - "User Settings", + "Workspaces - Entity APIs", "entities", - "custom-user-application-setting-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/users/{userId}/userSettings": { + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { "get": { - "operationId": "getAllEntities@UserSettings", + "operationId": "getAllEntities@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.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": "dataset,sourceFact,sourceAttribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -48477,9 +57736,18 @@ { "$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", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48488,6 +57756,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -48505,127 +57774,194 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "List all settings for a user", + "summary": "Get all Aggregated Facts", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] - }, + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { "post": { - "operationId": "createEntity@UserSettings", + "operationId": "searchEntities@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "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/JsonApiUserSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post new user settings for the user", + "summary": "The search endpoint (beta)", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/entities/users/{userId}/userSettings/{id}": { - "delete": { - "operationId": "deleteEntity@UserSettings", + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "get": { + "operationId": "getEntity@AggregatedFacts", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a setting for a user", - "tags": [ - "User Settings", - "entities", - "user-setting-controller" - ] - }, - "get": { - "operationId": "getEntity@UserSettings", - "parameters": [ { "in": "path", - "name": "userId", + "name": "objectId", "required": true, "schema": { "type": "string" } }, - { - "$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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.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": "dataset,sourceFact,sourceAttribute", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", + "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": { @@ -48633,97 +57969,62 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a setting for a user", + "summary": "Get an Aggregated Fact", "tags": [ - "User Settings", + "Facts", "entities", - "user-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@UserSettings", + "aggregated-fact-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "get": { + "operationId": "getAllEntities@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$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", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" - } - } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Put new user settings for the user", - "tags": [ - "User Settings", - "entities", - "user-setting-controller" - ] - } - }, - "/api/v1/entities/workspaces": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Workspaces", - "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;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48732,7 +58033,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -48740,8 +58041,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48759,9 +58071,18 @@ { "$ref": "#/components/parameters/sort" }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + "example": "metaInclude=permissions,origin,accessInfo,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48770,10 +58091,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "page", "all", "ALL" @@ -48791,23 +58111,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entities", + "summary": "Get all Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48817,12 +58137,19 @@ } }, "post": { - "description": "Space of the shared interest", - "operationId": "createEntity@Workspaces", + "operationId": "createEntity@AnalyticalDashboards", "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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -48830,8 +58157,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48842,7 +58180,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48851,10 +58189,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "all", "ALL" ], @@ -48870,12 +58207,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } } }, @@ -48886,39 +58223,130 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace entities", + "summary": "Post Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "post": { + "operationId": "searchEntities@AnalyticalDashboards", + "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/JsonApiAnalyticalDashboardOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Dashboards", + "entities", + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { "delete": { - "description": "Space of the shared interest", - "operationId": "deleteEntity@Workspaces", + "operationId": "deleteEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -48926,29 +58354,41 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Workspace entity", + "summary": "Delete a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Workspaces", + "operationId": "getEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48957,7 +58397,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -48965,8 +58405,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -48975,9 +58426,18 @@ }, "style": "form" }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48986,10 +58446,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "accessInfo", "all", "ALL" ], @@ -49006,23 +58465,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entity", + "summary": "Get a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49032,15 +58491,27 @@ } }, "patch": { - "description": "Space of the shared interest", - "operationId": "patchEntity@Workspaces", + "operationId": "patchEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49049,7 +58520,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -49057,8 +58528,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49072,12 +58554,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, @@ -49088,41 +58570,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Workspace entity", + "summary": "Patch a Dashboard", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "description": "Space of the shared interest", - "operationId": "updateEntity@Workspaces", + "operationId": "updateEntity@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": "name==someString;earlyAccess==someString;parent.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49131,7 +58625,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": "parent", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -49139,8 +58633,19 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49154,12 +58659,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } } }, @@ -49170,35 +58675,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Workspace entity", + "summary": "Put Dashboards", "tags": [ - "Workspaces - Entity APIs", + "Dashboards", "entities", - "workspace-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { "get": { - "operationId": "getAllEntities@AggregatedFacts", + "operationId": "getAllEntities@AttributeHierarchies", "parameters": [ { "in": "path", @@ -49225,7 +58730,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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49234,7 +58739,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": "dataset,sourceFact,sourceAttribute", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -49242,12 +58747,10 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "userIdentifiers", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -49303,23 +58806,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Aggregated Facts", + "summary": "Get all Attribute Hierarchies", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49327,11 +58830,112 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@AttributeHierarchies", + "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,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "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/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Attribute Hierarchies", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { "post": { - "operationId": "searchEntities@AggregatedFacts", + "operationId": "searchEntities@AttributeHierarchies", "parameters": [ { "in": "path", @@ -49382,12 +58986,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, @@ -49396,9 +59000,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49408,9 +59012,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "delete": { + "operationId": "deleteEntity@AttributeHierarchies", + "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 an Attribute Hierarchy", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@AggregatedFacts", + "operationId": "getEntity@AttributeHierarchies", "parameters": [ { "in": "path", @@ -49430,7 +59072,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": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49439,7 +59081,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": "dataset,sourceFact,sourceAttribute", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -49447,12 +59089,10 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "userIdentifiers", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -49498,23 +59138,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Aggregated Fact", + "summary": "Get an Attribute Hierarchy", "tags": [ - "Facts", + "Attribute Hierarchies", "entities", - "aggregated-fact-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49522,11 +59162,9 @@ "VIEW" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { - "get": { - "operationId": "getAllEntities@AnalyticalDashboards", + }, + "patch": { + "operationId": "patchEntity@AttributeHierarchies", "parameters": [ { "in": "path", @@ -49537,17 +59175,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" } }, @@ -49562,7 +59193,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", @@ -49571,18 +59202,9 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", - "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", + "attributes", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -49590,83 +59212,153 @@ "type": "array" }, "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + } + } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch an Attribute Hierarchy", + "tags": [ + "Attribute Hierarchies", + "entities", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@AttributeHierarchies", + "parameters": [ { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/sort" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } }, { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, + "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": { - "default": false, - "type": "boolean" + "type": "string" } }, { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,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,attributes", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "permissions", - "origin", - "accessInfo", - "page", - "all", + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Dashboards", + "summary": "Put an Attribute Hierarchy", "tags": [ - "Dashboards", + "Attribute Hierarchies", "entities", - "analytical-dashboard-controller" + "attribute-hierarchy-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "ANALYZE" ] } - }, - "post": { - "operationId": "createEntity@AnalyticalDashboards", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "get": { + "operationId": "getAllEntities@Attributes", "parameters": [ { "in": "path", @@ -49676,9 +59368,33 @@ "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;dataset.id==321;defaultView.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,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -49686,19 +59402,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -49707,9 +59415,27 @@ }, "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=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49720,7 +59446,7 @@ "enum": [ "permissions", "origin", - "accessInfo", + "page", "all", "ALL" ], @@ -49732,55 +59458,40 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Dashboards", + "summary": "Get all Attributes", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-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": [ - "ANALYZE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { "post": { - "operationId": "searchEntities@AnalyticalDashboards", + "operationId": "searchEntities@Attributes", "parameters": [ { "in": "path", @@ -49831,12 +59542,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, @@ -49845,9 +59556,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49857,47 +59568,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { - "delete": { - "operationId": "deleteEntity@AnalyticalDashboards", - "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 Dashboard", - "tags": [ - "Dashboards", - "entities", - "analytical-dashboard-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { "get": { - "operationId": "getEntity@AnalyticalDashboards", + "operationId": "getEntity@Attributes", "parameters": [ { "in": "path", @@ -49917,7 +59590,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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -49926,7 +59599,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -49934,19 +59607,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -49966,7 +59631,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49977,7 +59642,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -49994,23 +59658,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dashboard", + "summary": "Get an Attribute", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50020,7 +59684,7 @@ } }, "patch": { - "operationId": "patchEntity@AnalyticalDashboards", + "operationId": "patchEntity@Attributes", "parameters": [ { "in": "path", @@ -50040,7 +59704,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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -50049,7 +59713,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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -50057,19 +59721,11 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -50083,12 +59739,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } } }, @@ -50099,33 +59755,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dashboard", + "summary": "Patch an Attribute (beta)", "tags": [ - "Dashboards", + "Attributes", "entities", - "analytical-dashboard-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@AnalyticalDashboards", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { + "post": { + "operationId": "searchEntities@AutomationResults", "parameters": [ { "in": "path", @@ -50136,67 +59794,39 @@ } }, { - "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;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "filter", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "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,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", - "explode": false, - "in": "query", - "name": "include", + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "parameters", - "datasets", - "filterContexts", - "dashboardPlugins", - "computedAttributes", - "createdBy", - "modifiedBy", - "certifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -50204,35 +59834,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put Dashboards", + "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Automations", "entities", - "analytical-dashboard-controller" + "automation-result-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": [ - "ANALYZE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { + "/api/v1/entities/workspaces/{workspaceId}/automations": { "get": { - "operationId": "getAllEntities@AttributeHierarchies", + "operationId": "getAllEntities@Automations", "parameters": [ { "in": "path", @@ -50259,7 +59889,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -50268,7 +59898,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -50276,10 +59906,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -50335,23 +59978,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attribute Hierarchies", + "summary": "Get all Automations", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50361,7 +60004,7 @@ } }, "post": { - "operationId": "createEntity@AttributeHierarchies", + "operationId": "createEntity@Automations", "parameters": [ { "in": "path", @@ -50373,7 +60016,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -50381,10 +60024,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -50420,12 +60076,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, @@ -50436,35 +60092,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Attribute Hierarchies", + "summary": "Post Automations", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { + "/api/v1/entities/workspaces/{workspaceId}/automations/search": { "post": { - "operationId": "searchEntities@AttributeHierarchies", + "operationId": "searchEntities@Automations", "parameters": [ { "in": "path", @@ -50515,12 +60171,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, @@ -50529,9 +60185,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50541,9 +60197,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { "delete": { - "operationId": "deleteEntity@AttributeHierarchies", + "operationId": "deleteEntity@Automations", "parameters": [ { "in": "path", @@ -50567,21 +60223,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Attribute Hierarchy", + "summary": "Delete an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } }, "get": { - "operationId": "getEntity@AttributeHierarchies", + "operationId": "getEntity@Automations", "parameters": [ { "in": "path", @@ -50601,7 +60257,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -50610,7 +60266,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -50618,10 +60274,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -50667,23 +60336,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute Hierarchy", + "summary": "Get an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50693,7 +60362,7 @@ } }, "patch": { - "operationId": "patchEntity@AttributeHierarchies", + "operationId": "patchEntity@Automations", "parameters": [ { "in": "path", @@ -50713,7 +60382,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -50722,7 +60391,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -50730,10 +60399,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -50747,12 +60429,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } } }, @@ -50763,33 +60445,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute Hierarchy", + "summary": "Patch an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } }, "put": { - "operationId": "updateEntity@AttributeHierarchies", + "operationId": "updateEntity@Automations", "parameters": [ { "in": "path", @@ -50809,7 +60491,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -50818,7 +60500,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,attributes", + "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -50826,10 +60508,23 @@ "schema": { "items": { "enum": [ + "notificationChannels", + "analyticalDashboards", "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", "createdBy", "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -50843,12 +60538,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, @@ -50859,35 +60554,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Attribute Hierarchy", + "summary": "Put an Automation", "tags": [ - "Attribute Hierarchies", + "Automations", "entities", - "attribute-hierarchy-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "CREATE_AUTOMATION" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { "get": { - "operationId": "getAllEntities@Attributes", + "operationId": "getAllEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -50914,7 +60609,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -50923,7 +60618,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -50931,11 +60626,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -50992,23 +60693,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attributes", + "summary": "Get all Computed Attributes", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51016,11 +60717,120 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@ComputedAttributes", + "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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Computed Attributes", + "tags": [ + "Computed Attributes", + "entities", + "computed-attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to create Computed Attributes", + "permissions": [ + "CREATE_COMPUTED_ATTRIBUTE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { "post": { - "operationId": "searchEntities@Attributes", + "operationId": "searchEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -51055,51 +60865,89 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, + "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/JsonApiComputedAttributeOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Computed Attributes", + "entities", + "computed-attribute-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { + "delete": { + "operationId": "deleteEntity@ComputedAttributes", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - } - }, - "description": "Request successfully processed" + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "The search endpoint (beta)", + "summary": "Delete a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { + }, "get": { - "operationId": "getEntity@Attributes", + "operationId": "getEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -51119,7 +60967,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -51128,7 +60976,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -51136,11 +60984,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -51187,23 +61041,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute", + "summary": "Get a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51213,7 +61067,7 @@ } }, "patch": { - "operationId": "patchEntity@Attributes", + "operationId": "patchEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -51233,7 +61087,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;dataset.id==321;defaultView.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -51242,7 +61096,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": "dataset,defaultView,labels,attributeHierarchies", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -51250,11 +61104,17 @@ "schema": { "items": { "enum": [ - "datasets", + "userIdentifiers", + "facts", + "attributes", "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -51268,12 +61128,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } } }, @@ -51284,23 +61144,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch a Computed Attribute", "tags": [ - "Attributes", + "Computed Attributes", "entities", - "attribute-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51308,11 +61168,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { - "post": { - "operationId": "searchEntities@AutomationResults", + }, + "put": { + "operationId": "updateEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -51323,39 +61181,65 @@ } }, { + "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;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "origin", - "required": false, + "name": "filter", "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", + "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,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -51363,35 +61247,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Put a Computed Attribute", "tags": [ - "Automations", + "Computed Attributes", "entities", - "automation-result-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { "get": { - "operationId": "getAllEntities@Automations", + "operationId": "getAllEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51418,48 +61302,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -51507,23 +61356,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations", + "summary": "Get all Custom Application Settings", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51533,7 +61382,7 @@ } }, "post": { - "operationId": "createEntity@Automations", + "operationId": "createEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51543,41 +61392,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -51605,12 +61419,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, @@ -51621,35 +61435,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Automations", + "summary": "Post Custom Application Settings", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/search": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { "post": { - "operationId": "searchEntities@Automations", + "operationId": "searchEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51700,12 +61508,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, @@ -51714,9 +61522,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51726,9 +61534,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@Automations", + "operationId": "deleteEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51752,21 +61560,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Automation", + "summary": "Delete a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@Automations", + "operationId": "getEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51786,48 +61588,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -51865,23 +61632,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Automation", + "summary": "Get a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51891,7 +61658,7 @@ } }, "patch": { - "operationId": "patchEntity@Automations", + "operationId": "patchEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -51911,59 +61678,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, @@ -51974,33 +61706,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Automation", + "summary": "Patch a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@Automations", + "operationId": "updateEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -52020,59 +61746,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "applicationName==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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "visualizationObjects", - "metrics", - "attributes", - "labels", - "facts", - "computedAttributes", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, @@ -52083,35 +61774,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Automation", + "summary": "Put a Custom Application Setting", "tags": [ - "Automations", + "Workspaces - Settings", "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { "get": { - "operationId": "getAllEntities@ComputedAttributes", + "operationId": "getAllEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -52147,7 +61832,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -52156,16 +61841,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -52194,7 +61871,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,page,all", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -52203,7 +61880,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "page", "all", @@ -52222,23 +61898,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Computed Attributes", + "summary": "Get all Plugins", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52248,7 +61924,7 @@ } }, "post": { - "operationId": "createEntity@ComputedAttributes", + "operationId": "createEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -52260,7 +61936,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -52269,16 +61945,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -52289,7 +61957,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -52298,7 +61966,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -52315,12 +61982,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } } }, @@ -52331,35 +61998,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Computed Attributes", + "summary": "Post Plugins", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to create Computed Attributes", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_COMPUTED_ATTRIBUTE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { "post": { - "operationId": "searchEntities@ComputedAttributes", + "operationId": "searchEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -52410,12 +62077,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, @@ -52424,9 +62091,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52436,9 +62103,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { "delete": { - "operationId": "deleteEntity@ComputedAttributes", + "operationId": "deleteEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -52462,21 +62129,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Computed Attribute", + "summary": "Delete a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "get": { - "operationId": "getEntity@ComputedAttributes", + "operationId": "getEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -52505,7 +62172,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -52514,16 +62181,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -52543,7 +62202,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -52552,7 +62211,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -52570,23 +62228,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Computed Attribute", + "summary": "Get a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52596,7 +62254,7 @@ } }, "patch": { - "operationId": "patchEntity@ComputedAttributes", + "operationId": "patchEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -52625,7 +62283,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -52634,16 +62292,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -52657,12 +62307,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, @@ -52673,33 +62323,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Computed Attribute", + "summary": "Patch a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } }, "put": { - "operationId": "updateEntity@ComputedAttributes", + "operationId": "updateEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -52728,7 +62378,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -52737,16 +62387,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -52760,12 +62402,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, @@ -52776,35 +62418,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Computed Attribute", + "summary": "Put a Plugin", "tags": [ - "Computed Attributes", + "Plugins", "entities", - "computed-attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { + "/api/v1/entities/workspaces/{workspaceId}/datasets": { "get": { - "operationId": "getAllEntities@CustomApplicationSettings", + "operationId": "getAllEntities@Datasets", "parameters": [ { "in": "path", @@ -52831,13 +62473,37 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -52885,23 +62551,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Application Settings", + "summary": "Get all Datasets", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -52909,84 +62575,11 @@ "VIEW" ] } - }, - "post": { - "operationId": "createEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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/JsonApiCustomApplicationSettingPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Custom Application Settings", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { + "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { "post": { - "operationId": "searchEntities@CustomApplicationSettings", + "operationId": "searchEntities@Datasets", "parameters": [ { "in": "path", @@ -53037,12 +62630,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, @@ -53051,9 +62644,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53063,41 +62656,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { - "delete": { - "operationId": "deleteEntity@CustomApplicationSettings", - "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 Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] - }, + "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { "get": { - "operationId": "getEntity@CustomApplicationSettings", + "operationId": "getEntity@Datasets", "parameters": [ { "in": "path", @@ -53117,13 +62678,37 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -53161,23 +62746,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Custom Application Setting", + "summary": "Get a Dataset", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53187,7 +62772,7 @@ } }, "patch": { - "operationId": "patchEntity@CustomApplicationSettings", + "operationId": "patchEntity@Datasets", "parameters": [ { "in": "path", @@ -53207,92 +62792,48 @@ }, { "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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "custom-application-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@CustomApplicationSettings", - "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": "applicationName==someString;content==JsonNodeValue", + "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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode": false, "in": "query", - "name": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } } }, @@ -53303,29 +62844,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Custom Application Setting", + "summary": "Patch a Dataset (beta)", "tags": [ - "Workspaces - Settings", + "Datasets", "entities", - "custom-application-setting-controller" - ] + "dataset-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { + "/api/v1/entities/workspaces/{workspaceId}/documentTemplates": { "get": { - "operationId": "getAllEntities@DashboardPlugins", + "operationId": "getAllEntities@DocumentTemplates", "parameters": [ { "in": "path", @@ -53352,7 +62899,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -53427,23 +62974,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Plugins", + "summary": "Get all Document Templates", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53453,7 +63000,7 @@ } }, "post": { - "operationId": "createEntity@DashboardPlugins", + "operationId": "createEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -53511,12 +63058,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePostOptionalIdDocument" } } }, @@ -53527,114 +63074,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Plugins", + "summary": "Post Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { - "post": { - "operationId": "searchEntities@DashboardPlugins", - "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/JsonApiDashboardPluginOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/documentTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@DashboardPlugins", + "operationId": "deleteEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -53658,21 +63126,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Plugin", + "summary": "Delete a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@DashboardPlugins", + "operationId": "getEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -53692,7 +63160,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -53757,23 +63225,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Plugin", + "summary": "Get a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -53783,7 +63251,7 @@ } }, "patch": { - "operationId": "patchEntity@DashboardPlugins", + "operationId": "patchEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -53803,7 +63271,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -53836,12 +63304,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplatePatchDocument" } } }, @@ -53852,33 +63320,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Plugin", + "summary": "Patch a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@DashboardPlugins", + "operationId": "updateEntity@DocumentTemplates", "parameters": [ { "in": "path", @@ -53898,7 +63366,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -53931,12 +63399,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateInDocument" } } }, @@ -53947,35 +63415,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Plugin", + "summary": "Put a Document Template", "tags": [ - "Plugins", + "Publisher Documents", "entities", - "dashboard-plugin-controller" + "document-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets": { + "/api/v1/entities/workspaces/{workspaceId}/documents": { "get": { - "operationId": "getAllEntities@Datasets", + "operationId": "getAllEntities@Documents", "parameters": [ { "in": "path", @@ -54002,7 +63470,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -54011,7 +63479,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -54019,12 +63487,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -54080,23 +63545,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Datasets", + "summary": "Get all Documents", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54104,11 +63569,9 @@ "VIEW" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { + }, "post": { - "operationId": "searchEntities@Datasets", + "operationId": "createEntity@Documents", "parameters": [ { "in": "path", @@ -54119,75 +63582,136 @@ } }, { + "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": "origin", + "name": "include", "required": false, "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "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/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/documents/{objectId}": { + "delete": { + "operationId": "deleteEntity@Documents", + "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 Document", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Datasets", + "operationId": "getEntity@Documents", "parameters": [ { "in": "path", @@ -54207,7 +63731,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -54216,7 +63740,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -54224,12 +63748,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -54275,23 +63796,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dataset", + "summary": "Get a Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -54301,7 +63822,7 @@ } }, "patch": { - "operationId": "patchEntity@Datasets", + "operationId": "patchEntity@Documents", "parameters": [ { "in": "path", @@ -54321,7 +63842,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", + "example": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -54330,7 +63851,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": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -54338,12 +63859,9 @@ "schema": { "items": { "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -54357,12 +63875,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPatchDocument" } } }, @@ -54373,23 +63891,118 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Patch a Document", "tags": [ - "Datasets", + "Publisher Documents", "entities", - "dataset-controller" + "document-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Documents", + "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": "version==someString;title==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/JsonApiPublisherDocumentInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Document", + "tags": [ + "Publisher Documents", + "entities", + "document-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -58846,48 +68459,493 @@ "type": "array" }, "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Metrics", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to create Metrics", + "permissions": [ + "CREATE_METRIC" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { + "post": { + "operationId": "searchEntities@Metrics", + "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/JsonApiMetricOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "The search endpoint (beta)", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "delete": { + "operationId": "deleteEntity@Metrics", + "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 Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "get": { + "operationId": "getEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "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=permissions,origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "patch": { + "operationId": "patchEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Metric", + "tags": [ + "Metrics", + "entities", + "metric-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Metrics", + "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;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", + "metrics", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { @@ -58903,23 +68961,23 @@ "description": "Request successfully processed" } }, - "summary": "Post Metrics", + "summary": "Put a Metric", "tags": [ "Metrics", "entities", "metric-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to create Metrics", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_METRIC" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { - "post": { - "operationId": "searchEntities@Metrics", + "/api/v1/entities/workspaces/{workspaceId}/pageTemplates": { + "get": { + "operationId": "getAllEntities@PageTemplates", "parameters": [ { "in": "path", @@ -58944,6 +69002,45 @@ "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": "version==someString;title==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", @@ -58952,53 +69049,165 @@ "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/JsonApiPublisherDocumentPageTemplateOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Page Templates", + "tags": [ + "Publisher Documents", + "entities", + "page-template-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@PageTemplates", + "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/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/pageTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@PageTemplates", "parameters": [ { "in": "path", @@ -59022,11 +69231,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59036,7 +69245,7 @@ } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@PageTemplates", "parameters": [ { "in": "path", @@ -59056,7 +69265,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59065,7 +69274,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59074,16 +69283,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -59103,7 +69304,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -59112,7 +69313,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "origin", "all", "ALL" @@ -59130,23 +69330,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59156,7 +69356,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@PageTemplates", "parameters": [ { "in": "path", @@ -59176,7 +69376,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59185,7 +69385,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59194,16 +69394,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -59217,12 +69409,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplatePatchDocument" } } }, @@ -59233,23 +69425,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -59259,7 +69451,7 @@ } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@PageTemplates", "parameters": [ { "in": "path", @@ -59279,7 +69471,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": "version==someString;title==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -59288,7 +69480,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,computedAttributes,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -59297,16 +69489,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "computedAttributes", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -59320,12 +69504,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateInDocument" } } }, @@ -59336,23 +69520,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiPublisherDocumentPageTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Page Template", "tags": [ - "Metrics", + "Publisher Documents", "entities", - "metric-controller" + "page-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", diff --git a/schemas/gooddata-result-client.json b/schemas/gooddata-result-client.json index b77c3e45f..28aa72ee9 100644 --- a/schemas/gooddata-result-client.json +++ b/schemas/gooddata-result-client.json @@ -140,6 +140,130 @@ }, "type": "object" }, + "AnalyzeSavRequest": { + "description": "Bulk SPSS (.sav) file analysis request.", + "properties": { + "analyzeRequests": { + "description": "List of individual SPSS file analysis requests.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavRequestItem" + }, + "type": "array" + } + }, + "required": [ + "analyzeRequests" + ], + "type": "object" + }, + "AnalyzeSavRequestItem": { + "description": "SPSS (.sav) file analysis request.", + "properties": { + "config": { + "$ref": "#/components/schemas/AnalyzeSavRequestItemConfig" + }, + "location": { + "description": "Location of the SPSS file to analyze.", + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "AnalyzeSavRequestItemConfig": { + "description": "SPSS (.sav) file analysis request config.", + "properties": { + "resultRows": { + "description": "Number of rows to return as the preview of the file. The default is 100, the maximum is 1000.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AnalyzeSavResponse": { + "description": "Describes the results of an analysis of a single SPSS (.sav) file.", + "properties": { + "columns": { + "description": "List of column metadata.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponseColumn" + }, + "type": "array" + }, + "location": { + "description": "Location of the analyzed file in the source data source.", + "type": "string" + }, + "previewData": { + "description": "Preview of the first N rows of the file.", + "items": { + "description": "Preview of the first N rows of the file.", + "items": { + "description": "Preview of the first N rows of the file.", + "type": "object" + }, + "type": "array" + }, + "type": "array" + } + }, + "required": [ + "columns", + "location", + "previewData" + ], + "type": "object" + }, + "AnalyzeSavResponseColumn": { + "description": "Describes a column of an SPSS file.", + "properties": { + "label": { + "description": "Label of the column, in a survey file usually the question text. Null if there is none.", + "type": "string" + }, + "name": { + "description": "Name of the column as specified in the file.", + "type": "string" + }, + "type": { + "description": "Type of the column (e.g. string, float64, date32).", + "type": "string" + }, + "valueLabels": { + "description": "Labels of the column values in file order. Null if there are none.", + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponseValueLabel" + }, + "type": "array" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, + "AnalyzeSavResponseValueLabel": { + "description": "Label of one value of an SPSS column.", + "properties": { + "label": { + "description": "The label of the value, in a survey file usually the answer text.", + "type": "string" + }, + "value": { + "description": "The value: a number in a numeric column, a string in a string column.", + "type": "object" + } + }, + "required": [ + "label", + "value" + ], + "type": "object" + }, "CacheRemovalInterval": { "description": "Information about a period in time and how much cached data was removed.", "properties": { @@ -448,7 +572,8 @@ "type": { "description": "Type of the file.", "enum": [ - "CSV" + "CSV", + "SAV" ], "type": "string" } @@ -647,6 +772,71 @@ ], "type": "object" }, + "ImportSavRequest": { + "description": "Request containing the information necessary to import one or more SPSS (.sav) files from the staging area.", + "properties": { + "tables": { + "description": "Information about the individual tables.", + "items": { + "$ref": "#/components/schemas/ImportSavRequestTable" + }, + "type": "array" + } + }, + "required": [ + "tables" + ], + "type": "object" + }, + "ImportSavRequestTable": { + "description": "Information about a particular table imported from an SPSS file.", + "properties": { + "name": { + "description": "Name of the table.", + "type": "string" + }, + "source": { + "$ref": "#/components/schemas/ImportSavRequestTableSource" + } + }, + "required": [ + "name", + "source" + ], + "type": "object" + }, + "ImportSavRequestTableSource": { + "description": "Information about the SPSS source data of a particular table.", + "properties": { + "location": { + "description": "Location of the data in the staging area.", + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "ImportSavResponse": { + "description": "Response containing the information about the imported SPSS (.sav) file.", + "properties": { + "name": { + "description": "Name of the table the file was imported to.", + "type": "string" + }, + "version": { + "description": "Version the file was imported as.", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "name", + "version" + ], + "type": "object" + }, "OrganizationCacheSettings": { "description": "Settings for organization cache.", "properties": { @@ -1088,7 +1278,7 @@ }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv": { "post": { - "description": "Import the CSV files at the given locations in the staging area to the final location.", + "description": "Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file.", "operationId": "importCsv", "parameters": [ { @@ -1138,6 +1328,58 @@ } } }, + "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav": { + "post": { + "description": "Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file.", + "operationId": "importSav", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportSavRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ImportSavResponse" + }, + "type": "array" + } + } + }, + "description": "Successful import." + } + }, + "summary": "Import SPSS files", + "tags": [ + "Data source files import", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles": { "post": { "description": "List all the files in the given data source.", @@ -1274,6 +1516,48 @@ } } }, + "/api/v1/actions/fileStorage/staging/analyzeSav": { + "post": { + "description": "Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations.", + "operationId": "analyzeSav", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyzeSavRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/AnalyzeSavResponse" + }, + "type": "array" + } + } + }, + "description": "Successful analysis." + } + }, + "summary": "Analyze SPSS files", + "tags": [ + "Data source files analysis", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, "/api/v1/actions/fileStorage/staging/upload": { "post": { "description": "Provides a location for uploading staging files.", diff --git a/schemas/gooddata-scan-client.json b/schemas/gooddata-scan-client.json index 3216a4d5c..b69965589 100644 --- a/schemas/gooddata-scan-client.json +++ b/schemas/gooddata-scan-client.json @@ -219,6 +219,12 @@ "example": "INT", "type": "string" }, + "defaultLabelOf": { + "description": "(EXPERIMENTAL) Name of the column whose values this column labels. Logical model generation makes this column the default label of the attribute on that column, sorted by that column.", + "example": "gender", + "maxLength": 255, + "type": "string" + }, "description": { "description": "Column description/comment from database", "example": "Customer unique identifier", @@ -296,6 +302,13 @@ }, "type": "array" }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Additional properties of the table that the data source passes on to the modeler and other callers. The data source decides which keys it sends. A caller uses the keys it understands and skips all other keys.", + "type": "object" + }, "type": { "description": "Table type: TABLE or VIEW.", "example": "TABLE", @@ -786,7 +799,6 @@ "FLEXCONNECT", "STARROCKS", "ATHENA", - "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO",